部分バッチ取得

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
データ取り込み

作成対象：

開発者

部分バッチ取得は、エラーを含むデータを特定のしきい値まで取得する機能です。この機能を使用すると、正しいデータをすべて Adobe Experience Platform に正しく取得し、間違ったデータはその理由の詳細とともにすべて別々にバッチ処理されます。

このドキュメントでは、部分バッチ取得を管理するためのチュートリアルを提供します。

はじめに

このチュートリアルでは、部分バッチ取得に関わる様々な Adobe Experience Platform サービスに関する十分な知識が必要です。このチュートリアルを開始する前に、次のサービスのドキュメントを確認してください。

バッチ取り込み:CSV や Parquet などのデータファイルからデータを取 Platform 込んで保存する方法。
Experience Data Model (XDM)：Platform が、カスタマーエクスペリエンスデータを整理する際に使用する、標準化されたフレームワーク。

以下の節では、Platform API を正しく呼び出すために知っておく必要がある追加情報を示します。

API 呼び出し例の読み取り

ここでは、リクエストの形式を説明するために API 呼び出しの例を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。

必須ヘッダーの値の収集

Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。

Authorization： Bearer {ACCESS_TOKEN}
x-api-key： {API_KEY}
x-gw-ims-org-id： {ORG_ID}

Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

x-sandbox-name：{SANDBOX_NAME}

NOTE

Platform のサンドボックスについて詳しくは、サンドボックスの概要に関するドキュメントを参照してください。

API での部分バッチ取り込みのバッチの有効化 enable-api

NOTE

この節では、API を使用してバッチを有効にして部分バッチ取り込みを行う方法について説明します。 UI の使用方法については、UI での部分バッチ取り込みのバッチを有効にするステップを参照してください。

部分取り込みを有効にして新しいバッチを作成できます。

新しいバッチを作成するには、バッチ取得開発者ガイドの手順に従います。 バッチを作成 ステップに到達したら、リクエスト本文に次のフィールドを追加します。

{
    "enableErrorDiagnostics": true,
    "partialIngestionPercent": 5
}

プロパティ

説明

enableErrorDiagnostics

バッチに関 Platform る詳細なエラーメッセージを生成できるフラグ。

partialIngestionPercent

バッチ全体が失敗する前に許容できるエラーの割合。この例では、失敗する前にバッチの最大 5% がエラーになる可能性があります。

UI での部分バッチ取り込みのバッチを有効にする enable-ui

NOTE

この節では、UI を使用してバッチを有効にして部分バッチ取り込みを行う方法について説明します。 API を使用してバッチ取り込みのバッチを既に有効にしている場合は、次の節に進みます。

Platform UI を使用してバッチで部分取り込みを有効にするには、ソース接続を使用して新しいバッチを作成、既存のデータセットで新しいバッチを作成または「CSV を XDM フローにマッピング」を使用して新しいバッチを作成します。

新しいソース接続の作成 new-source

新しいソース接続を作成するには、ソースの概要に一覧表示されている手順に従います。 データフローの詳細 手順に到達したら、部分取り込み および エラー診断 フィールドに注意します。

「部分取得」切り替えを使用すると、部分バッチ取得の使用を有効または無効にできます。

エラー診断 切替スイッチは、部分取り込み 切替スイッチがオフの場合にのみ表示されます。この機能を使用 Platform ると、取り込んだバッチに関する詳細なエラーメッセージを生成できます。 部分取り込み 切り替えスイッチがオンになっている場合、拡張エラー診断が自動的に適用されます。