此 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。若要啟動工作負載以批次處理決策,請向以下專案發出POST請求: /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會針對每個範圍傳回一個選項,但您可以指定此欄位以明確要求更多選項。 每個範圍最多可請求30個選項,最少為1個。 | 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 |
組織識別碼。 | 9GTO98D5F@AdobeOrg |
xdm:containerId |
容器識別碼。 | 0948b1c5-fff8-3b76-ba17-909c6b93b5a2 |
ode:createDate |
決定工作負載請求的建立時間。 | 1648078924834 |
ode:status |
工作負載的狀態。 | ode:status: "QUEUED" |
若要擷取有關特定決定的資訊,請向以下網站發出GET請求: /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 |
工作負荷的狀態從「已排入佇列」開始,並變更為「處理中」、「正在擷取」、「已完成」或「錯誤」。 | ode:status: "COMPLETED" |
ode:statusDetail |
如果狀態為「正在處理」或「正在擷取」,這會顯示更多詳細資料,例如sparkJobId和batchID。 如果狀態為「ERROR」,則顯示錯誤詳細資料。 |
依照本API指南,您已使用檢查工作負荷狀態和傳送的優惠 Batch Decisioning] API。 如需詳細資訊,請參閱 決策管理概觀.