此 Batch Decisioning API可讓組織對單一呼叫中指定區段中的所有設定檔使用決策功能。 區段中每個設定檔的選件內容會放置於Adobe Experience Platform資料集中,供自訂批次工作流程使用。
使用 Batch Decisioning API,您可以為資料集填入Adobe Experience Platform區段中所有設定檔的最佳選件,以供決策範圍使用。 例如,組織可能想要執行 Batch Decisioning 以便他們能將選件傳送給訊息傳送廠商。 然後,這些選件會作為內容,傳送出去以批次傳送訊息給相同的使用者區段。
為此,本組織將:
執行 Batch Decisioning API,包含兩個請求:
A 批次POST請求 啟動工作量以批處理選件選擇。
A 批次GET請求 獲取批工作量狀態。
將資料集匯出至訊息傳送廠商API。
批次決策也可使用Journey Optimizer介面來執行。 如需詳細資訊,請參閱 本節,提供使用批次決策時需考量的全域先決條件和限制資訊。
使用此API之前,請務必完成下列必要步驟。
若要準備一或多個決策,請確定您已建立資料集、區段和決策。 若需了解這些必要條件,請參閱 本節.
全部 Batch Decisioning 除了 Decision Management API開發人員指南:
Content-Type
: application/json
x-request-id
:識別請求的唯一字串。x-sandbox-name
:沙箱名稱。x-sandbox-id
:沙箱ID。要啟動工作量以批次處理決策,請向 /workloads/decisions
端點。
有關批處理作業處理時間的詳細資訊,請參閱 本節.
API格式
POST {ENDPOINT_PATH}/{CONTAINER_ID}/workloads/decisions
參數 | 說明 | 範例 |
---|---|---|
{ENDPOINT_PATH} |
存放庫API的端點路徑。 | https://platform.adobe.io/data/core/ode |
{CONTAINER_ID} |
決策所在的容器。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
要求
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
}'
屬性 | 說明 | 範例 |
---|---|---|
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 |
這是選用欄位,顯示決策範圍所請求的選項等項目數。 依預設,API會針對每個範圍傳回一個選項,但您可以指定此欄位,明確要求更多選項。 每個範圍最少可請求1個選項,最多可請求30個選項。 | 1 |
xdm:includeContent |
這是選用欄位,是 false 依預設。 若 true ,則選件內容會包含在資料集的決策事件中。 |
false |
請參閱 決策管理檔案 ,以了解主要概念和屬性的概觀。
回應
{
"@id": "47efef25-4bcf-404f-96e2-67c4f784a1f5",
"xdm:imsOrgId": "9GTO98D5F@AdobeOrg",
"xdm:containerId": "0948b1c5-fff8-3b76-ba17-909c6b93b5a2",
"ode:createDate": 1648078924834,
"ode:status": "QUEUED"
}
屬性 | 說明 | 範例 |
---|---|---|
@id |
由決策管理生成的UUID,用於標識單個工作負載。 | 5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8 |
xdm:imsOrgId |
組織ID。 | 9GTO98D5F@AdobeOrg |
xdm:containerId |
容器ID。 | 0948b1c5-fff8-3b76-ba17-909c6b93b5a2 |
ode:createDate |
建立決策工作量請求的時間。 | 1648078924834 |
ode:status |
工作負載的狀態。 | ode:status: "QUEUED" |
若要擷取特定決策的資訊,請向 /workloads/decisions
端點,同時為您的決策提供相應的工作量ID值。
API格式
GET {ENDPOINT_PATH}/{CONTAINER_ID}/workloads/decisions/{WORKLOAD_ID}
參數 | 說明 | 範例 |
---|---|---|
{ENDPOINT_PATH} |
存放庫API的端點路徑。 | https://platform.adobe.io/data/core/ode |
{CONTAINER_ID} |
決策所在的容器。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{WORKLOAD_ID} |
由決策管理生成的UUID,用於標識單個工作負載。 | 47efef25-4bcf-404f-96e2-67c4f784a1f5 |
要求
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"
}
屬性 | 說明 | 範例 |
---|---|---|
@id |
由決策管理生成的UUID,用於標識單個工作負載。 | 5d0ffb5e-dfc6-4280-99b6-0bf3131cb8b8 |
xdm:imsOrgId |
組織ID | 9GTO98D5F@AdobeOrg |
xdm:containerId |
容器ID | 0948b1c5-fff8-3b76-ba17-909c6b93b5a2 |
ode:createDate |
建立決策工作量請求的時間。 | 1648076994405 |
ode:status |
工作負載的狀態以「QUEUED」開始,並更改為「PROCESSING」、「INGESTING」、「COMPLETED」或「ERROR」。 | ode:status: "COMPLETED" |
ode:statusDetail |
如果狀態為「PROCESSING」或「INGESTING」,則會顯示sparkJobId和batchID等更多詳細資訊。 如果狀態為「ERROR」,則會顯示錯誤詳細資訊。 |
依照本API指南,您已使用檢查工作負載狀態並傳送選件 Batch Decisioning] API。 如需詳細資訊,請參閱 決策管理概述.