完成测试阶段后, ad-hoc activation API 现在,所有Experience Platform客户均可使用(GA)。 在GA版本中,API已升级到版本2。 步骤4(获取最新的区段导出作业ID),因为API不再需要导出ID。
请参阅 运行临时激活作业 有关更多信息,请参阅本教程的下文。
临时激活API允许营销人员以编程方式快速高效地将受众区段激活到目标,以应对需要立即激活的情况。
使用临时激活API将完整文件导出到所需的文件接收系统。 Ad-hoc audience激活仅受 批量基于文件的目标.
下图说明了通过临时激活API激活区段的端到端工作流程,包括每24小时在Platform中发生一次的分段作业。
一家在线零售商准备进行有限的闪购,希望在短时间通知客户。 通过Experience Platform临时激活API,营销团队可以按需导出区段,并快速向客户群发送促销电子邮件。
酒店预计接下来几天天气会很恶劣,团队想要迅速通知到达的客人,以便他们可以据此进行规划。 营销团队可以使用Experience Platform临时激活API根据需要导出区段,并通知客人。
IT经理可以使用Experience Platform临时激活API按需导出区段,因此他们可以测试与Adobe Experience Platform的自定义集成,并确保一切正常工作。
使用临时激活API时,请记住以下护栏。
Adobe Experience Platform每24小时运行一次计划分段作业。 临时激活API根据最新的分段结果运行。
在调用Adobe Experience Platform API之前,请确保满足以下先决条件:
developer
和 user
为Adobe Experience Platform API产品配置文件启用了角色。 联系您的 Admin Console 管理员为您的帐户启用这些角色。要调用Platform API,您必须先完成 身份验证教程. 完成身份验证教程可为所有Experience PlatformAPI调用中每个所需标头的值,如下所示:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Experience Platform中的资源可以与特定虚拟沙箱隔离。 在对Platform API的请求中,您可以指定操作将在其中进行的沙盒的名称和ID。 这些是可选参数。
{SANDBOX_NAME}
有关Experience Platform中沙箱的详细信息,请参阅 沙盒概述文档.
所有包含有效负载(POST、PUT、PATCH)的请求都需要额外的媒体类型标头:
application/json
您必须先在平台UI中为所选目标配置激活流程,然后才能通过临时激活API激活区段。
这包括转到激活工作流、选择您的区段、配置计划并激活它们。 您可以使用UI或API创建激活流程:
在临时激活API的v2中,您无需获取最新的区段导出作业ID。 您可以跳过此步骤并继续执行下一步。
在为批处理目标配置激活流程后,每24小时自动开始运行一次计划分段作业。
在运行临时激活作业之前,必须获取最新区段导出作业的ID。 您必须在临时激活作业请求中传递此ID。
按照描述的说明操作 此处 以检索所有区段导出作业的列表。
在响应中,查找包含以下架构属性的第一个记录。
"schema":{
"name":"_xdm.context.profile"
}
区段导出作业ID位于 id
属性,如下所示。
Adobe Experience Platform每24小时运行一次计划分段作业。 临时激活API根据最新的分段结果运行。
请注意以下一次性约束:在运行临时激活作业之前,请确保从根据您在 步骤3 — 在Platform UI中创建激活流程.
在运行临时激活作业之前,请确保区段的计划区段导出作业已完成。 请参阅 目标数据流监控 有关如何监控激活流状态的信息。 例如,如果激活数据流显示 处理 状态,请等待其完成,然后再运行ad-hoc激活作业以导出完整文件。
区段导出作业完成后,您可以触发激活。
目前,每个临时激活作业最多可激活80个区段。 尝试激活每个作业80个以上的区段将导致作业失败。 此行为可能会在未来版本中发生更改。
必须将 Accept: application/vnd.adobe.adhoc.activation+json; version=2
标头,以便使用ad-hoc激活API的v2。
curl --location --request POST 'https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun' \
--header 'x-gw-ims-org-id: 5555467B5D8013E50A494220@AdobeOrg' \
--header 'Authorization: Bearer {{token}}' \
--header 'x-sandbox-id: 6ef74723-3ee7-46a4-b747-233ee7a6a41a' \
--header 'x-sandbox-name: {sandbox-id}' \
--header 'Accept: application/vnd.adobe.adhoc.activation+json; version=2' \
--header 'Content-Type: application/json' \
--data-raw '{
"activationInfo":{
"destinationId1":[
"segmentId1",
"segmentId2"
],
"destinationId2":[
"segmentId2",
"segmentId3"
]
}
}'
属性 | 描述 |
---|---|
|
要激活区段的目标实例的ID。 您可以通过导航到 目标 > 浏览 ,然后单击所需的目标行以显示右边栏中的目标ID。 有关更多信息,请阅读 目标工作区文档. |
|
要激活到选定目标的区段的ID。 |
已弃用的请求类型. 此示例类型描述API版本1的请求类型。 在临时激活API的v2中,您不需要包含最新的区段导出作业ID。
curl -X POST https://platform.adobe.io/data/core/activation/disflowprovider/adhocrun \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-d '
{
"activationInfo":{
"destinationId1":[
"segmentId1",
"segmentId2"
],
"destinationId2":[
"segmentId2",
"segmentId3"
]
},
"exportIds":[
"exportId1"
]
}
属性 | 描述 |
---|---|
|
要激活区段的目标实例的ID。 您可以通过导航到 目标 > 浏览 ,然后单击所需的目标行以显示右边栏中的目标ID。 有关更多信息,请阅读 目标工作区文档. |
|
要激活到选定目标的区段的ID。 |
|
在响应 区段导出 工作。 请参阅 步骤4:获取最新的区段导出作业ID 以了解有关如何查找此ID的说明。 |
成功响应会返回HTTP状态200。
{
"order":[
{
"segment":"db8961e9-d52f-45bc-b3fb-76d0382a6851",
"order":"ef2dcbd6-36fc-49a3-afed-d7b8e8f724eb",
"statusURL":"https://platform.adobe.io/data/foundation/flowservice/runs/88d6da63-dc97-460e-b781-fc795a7386d9"
}
]
}
属性 | 描述 |
---|---|
segment |
已激活区段的ID。 |
order |
区段被激活到的目标的ID。 |
statusURL |
激活流程的状态URL。 您可以使用 流量服务API. |
Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码 和 请求标头错误 平台疑难解答指南中。
使用临时激活API时,您可能会遇到特定于此API端点的错误消息。 查看表格,了解在表格显示时如何解决这些问题。
错误消息 | 解决方案 |
---|---|
已针对区段运行 segment ID 订购 dataflow ID 使用运行id flow run ID |
此错误消息表示当前正在为区段进行临时激活流程。 等待作业完成,然后再次触发激活作业。 |
区段 <segment name> 不是此数据流的一部分或超出计划范围! |
此错误消息表示您选择激活的区段未映射到数据流,或者为区段设置的激活计划已过期或尚未启动。 检查区段是否确实映射到数据流,并验证区段激活计划是否与当前日期重叠。 |