Batch Decisioning API を使用したオファーの配信 deliver-offers-batch
Batch Decisioning API を使用すると、組織は、1 回の呼び出しで特定のオーディエンスのすべてのプロファイルに対して決定支援機能を使用できます。オーディエンス内の各プロファイルに対するオファーコンテンツは、Adobe Experience Platform データセットに配置され、カスタムバッチワークフローで使用できます。
Batch Decisioning API を使用すると、決定範囲の Adobe Experience Platform オーディエンスに含まれるすべてのプロファイルに最適なオファーを、データセットに入力できます。例えば、ある組織が Batch Decisioning を実行して、メッセージ配信ベンダーにオファーを送信できるようにするとします。その場合、これらのオファーは、同じユーザーオーディエンスに対してバッチメッセージ配信用に送信されるコンテンツとして使用されます。
これを実現するため、組織は次の手順を実行します。
-
次の 2 つのリクエストを含む Batch Decisioning API を実行します。
-
バッチ POST リクエスト で、オファーの選択をバッチ処理するワークロードを開始します。
-
バッチ GET リクエスト で、バッチのワークロードステータスを取得します。
-
-
データセットをメッセージ配信ベンダー API にエクスポートします。
- データセットごとの実行中のバッチジョブの数:データセットごとに一度に最大 5 つのバッチジョブを実行できます。同じ出力データセットを持つその他のバッチリクエストがキューに追加されます。前のジョブの実行が完了したら、キュー内のジョブがピックアップされ処理されます。
- フリークエンシーキャップ:1 日に 1 回、プロファイルスナップショットからバッチが実行されます。Batch Decisioning API は頻度を制限し、常に最新のスナップショットからプロファイルを読み込みます。
はじめに getting-started
この API を使用する前に、次の前提条件の手順を実行してください。
決定の準備 prepare-decision
1 つ以上の決定を準備するには、データセット、オーディエンスおよび決定が作成されていることを確認します。これらの前提条件について詳しくは、この節を参照してください。
API の要件 api-requirements
すべての Batch Decisioning リクエストには、Decision Management API 開発者ガイドで言及されているものに加え、次のヘッダーが必要になります。
Content-Type
:application/json
x-request-id
:リクエストを識別する一意の文字列。x-sandbox-name
:サンドボックス名。
バッチ処理の開始 start-a-batch-process
ワークロードを開始して決定をバッチ処理するには、/workloads/decisions
エンドポイントに対して POST リクエストを実行します。
API 形式
POST {ENDPOINT_PATH}/workloads/decisions
{ENDPOINT_PATH}
https://platform.adobe.io/data/core/dwm
リクエスト
curl -X POST 'https://platform.adobe.io/data/core/dwm/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
}'
xdm:segmentIds
609028e4-e66c-4776-b0d9-c782887e2273
xdm:dataSetId
6196b4a1a63bd118dafe093c
xdm:propositionRequests
placementId
および activityId
を含むラッパーxdm:activityId
xcore:offer-activity:1410cdcda196707b
xdm:placementId
xcore:offer-placement:1410c4117306488a
xdm:itemCount
1
xdm:includeContent
false
です。true
の場合、オファーのコンテンツは、データセットの決定イベントに含まれます。false
詳しくは、意志決定管理ドキュメントで、主な概念とプロパティの概要を参照してください。
応答
{
"@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
"xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
"ode:createDate": 1648078924834,
"ode:status": "QUEUED"
}
@id
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
9GTO98D5F@AdobeOrg
ode:createDate
1648078924834
ode:status
ode:status: "QUEUED"
バッチ決定に関する情報の取得 retrieve-information-on-a-batch-decision
特定の決定に関する情報を取得するには、/workloads/decisions
エンドポイントに対して GET リクエストを実行し、決定に対応するワークロード ID 値を指定します。
API 形式
GET {ENDPOINT_PATH}/workloads/decisions/{WORKLOAD_ID}
{ENDPOINT_PATH}
https://platform.adobe.io/data/core/dwm
{WORKLOAD_ID}
47efef25-4bcf-404f-96e2-67c4f784a1f5
リクエスト
curl -X GET 'https://platform.adobe.io/data/core/dwm/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}",
"ode:createDate": 1648076994405,
"ode:status": "COMPLETED"
}
@id
5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8
xdm:imsOrgId
9GTO98D5F@AdobeOrg
ode:createDate
1648076994405
ode:status
ode:status: "COMPLETED"
ode:statusDetail
次の手順 next-steps
この API ガイドでは、Batch Decisioning API を使用してワークロードのステータスを確認し、オファーを配信しました。詳しくは、意思決定管理の概要を参照してください。