使用 Batch Decisioning API

的 Batch Decisioning API允许组织在一次调用中对给定区段中的所有用户档案使用决策功能。 区段中每个用户档案的选件内容都放置在Adobe Experience Platform数据集中,该数据集可用于自定义批量工作流。

使用 Batch Decisioning API中,您可以使用Adobe Experience Platform区段中所有用户档案的最佳选件为决策范围填充数据集。 例如,组织可能希望运行 Batch Decisioning 以便他们向消息投放供应商发送优惠。 然后,这些选件将用作发出的内容,以便将批量消息交付到同一用户区段。

为此,组织将:

  • 运行 Batch Decisioning API,其中包含两个请求:

    1. A 批量POST请求 启动工作量以批量处理选件选择。

    2. A 批量GET请求 以获取批处理工作负载状态。

  • 将数据集导出到消息传递供应商API。

注意

批量决策也可以使用Journey Optimizer界面执行。 有关更多信息,请参阅 此部分,其中提供了有关使用批量决策时需要考虑的全局先决条件和限制的信息。

  • 每个数据集正在运行的批处理作业数:每个数据集一次最多可以运行5个批处理作业。 具有相同输出数据集的任何其他批处理请求都会添加到队列中。 在上一个作业完成运行后,将选取已排队的作业进行处理。
  • 频率封顶:每天发生一次的配置文件快照的批处理运行。 的 Batch Decisioning API会限制频率,并始终从最新快照加载用户档案。

快速入门

使用此API之前,请确保完成以下先决条件步骤。

准备决策

要准备一个或多个决策,请确保已创建数据集、区段和决策。 有关这些先决条件的详细信息,请参阅 此部分.

API要求

全部 Batch Decisioning 除了在 决策管理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 包含的包装器 placementIdactivityId
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 如果状态为“正在处理”或“正在摄取”,则会显示更多详细信息,如sparkJobId和batchID。 如果状态为“ERROR”,则会显示错误详细信息。

后续步骤

按照本API指南,您已检查工作负载状态,并使用交付选件 Batch Decisioning API。 有关更多信息,请参阅 决策管理概述.

在此页面上