Batch Decisioning API を使用したオファーの配信

Batch Decisioning API を使用すると、1 回の呼び出しの特定のセグメントで、すべてのプロファイルに対して、意思決定機能を使用できます。セグメント内の各プロファイルに対するオファーコンテンツは、Adobe Experience Platform データセットに配置され、カスタムバッチワークフローで使用できます。

Batch Decisioning API を使用すると、決定範囲に関する Adobe Experience Platform セグメントのすべてのプロファイルにとって最適なオファーを、データセットに入力できます。例えば、ある組織が Batch Decisioning を実行して、メッセージ配信ベンダーにオファーを送信できるようにします。その後、これらのオファーは、同じセグメントのユーザーに対してバッチメッセージ配信用に送信されるコンテンツとして使用されます。

これを実現するため、組織は次の手順を実行します。

• 次の 2 つのリクエストを含む Batch Decisioning API を実行します。

  1. バッチ POST リクエスト​で、オファーの選択をバッチ処理するワークロードを開始します。

  2. バッチ GET リクエスト​で、バッチのワークロードステータスを取得します。

• データセットをメッセージ配信ベンダー API にエクスポートします。

• データセットごとの実行中のバッチジョブの数：データセットごとに一度に最大 5 つのバッチジョブを実行できます。同じ出力データセットを持つその他のバッチリクエストがキューに追加されます。前のジョブの実行が完了したら、キュー内のジョブがピックアップされ処理されます。
• フリークエンシーキャップ：1 日に 1 回、プロファイルスナップショットからバッチが実行されます。Batch Decisioning API は頻度を制限し、常に最新のスナップショットからプロファイルを読み込みます。

はじめに

この API を使用する前に、次の前提条件の手順を実行してください。

決定の準備

1 つ以上の決定を準備するには、データセット、セグメント、決定が作成されていることを確認します。 これらの前提条件について詳しくは、この節を参照してください。

API の要件

すべての Batch Decisioning リクエストには、Decision Management API 開発者ガイドで言及されているものに加え、次のヘッダーが必要になります。

• Content-Type：application/json
• x-request-id：リクエストを識別する一意の文字列。
• x-sandbox-name：サンドボックス名。
• x-sandbox-id：サンドボックス ID。

バッチ処理の開始

ワークロードを開始して決定をバッチ処理するには、/workloads/decisions エンドポイントに対して POST リクエストを実行します。

API 形式

POST {ENDPOINT_PATH}/{CONTAINER_ID}/workloads/decisions

リクエスト

curl -X POST 'https://platform.adobe.io/data/core/ode/0948b1c5-fff8-3b76-ba17-909c6b93b5a2/workloads/decisions' \
-H 'x-request-id: f671a589-eb7b-432f-b6b9-23d5b796b4dc' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-d '{
  "xdm:segmentIds": [
    "609028e4-e66c-4776-b0d9-c782887e2273"
  ],
  "xdm:dataSetId": "6196b4a1a63bd118dafe093c",
  "xdm:propositionRequests": [
        {
            "xdm:activityId": "xcore:offer-activity:1410cdcda196707b",
            "xdm:placementId": "xcore:offer-placement:1410c4117306488a",
            "xdm:itemCount": 1
        }
  ],
  "xdm:includeContent": false
}'

詳しくは、意志決定管理ドキュメントで、主な概念とプロパティの概要を参照してください。

応答

{
    "@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
    "xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
    "xdm:containerId": "0948b1c5-fff8-3b76-ba17-909c6b93b5a2",
    "ode:createDate": 1648078924834,
    "ode:status": "QUEUED"
}

バッチ決定に関する情報の取得

特定の決定に関する情報を取得するには、/workloads/decisions エンドポイントに対して GET リクエストを実行し、決定に対応するワークロード ID 値を指定します。

API 形式

GET  {ENDPOINT_PATH}/{CONTAINER_ID}/workloads/decisions/{WORKLOAD_ID}

リクエスト

curl -X GET 'https://platform.adobe.io/data/core/ode/0948b1c5-fff8-3b76-ba17-909c6b93b5a2/workloads/decisions/f395ab1f-dfaf-48d4-84c9-199ad6354591' \
-H 'x-request-id: 7832a42a-d4e5-413b-98e8-e49bef056436' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H'x-sandbox-id: {SANDBOX_ID}' \
-H 'Authorization: Bearer {ACCESS_TOKEN}'

応答

{
    "@id": "f395ab1f-dfaf-48d4-84c9-199ad6354591",
    "xdm:imsOrgId": "{IMS_ORG}",
    "xdm:containerId": "0948b1c5-fff8-3b76-ba17-909c6b93b5a2",
    "ode:createDate": 1648076994405,
    "ode:status": "COMPLETED"
}

次の手順

この API ガイドでは、Batch Decisioning API を使用してワークロードのステータスを確認し、オファーを配信しました。詳しくは、意思決定管理の概要を参照してください。

Business.Adobe.com リソース