此 Batch Decisioning API允许组织在一次调用中对给定区段中的所有用户档案使用决策功能。 区段中每个用户档案的选件内容都放在Adobe Experience Platform数据集中,可用于自定义批处理工作流。
使用 Batch Decisioning 之后,您可以在数据集中为决策范围的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会为每个范围返回一个选项,但您可以通过指定此字段明确要求提供更多选项。 每个作用域可请求至少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" |
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 |
这将显示更多详细信息,例如,如果状态为“PROCESSING”或“INGESTING”,则显示sparkJobId和batchID。 如果状态为“ERROR”,则显示错误详细信息。 |
按照本API指南,您已使用检查工作负荷状态和已交付的选件 Batch Decisioning] API。 欲了解更多信息,请参见 决策管理概述.