通过临时激活API将受众按需激活到批处理目标

概述 overview

临时激活API允许营销人员以编程方式快速高效地将受众受众激活到目标，以满足立即激活的需求。

使用临时激活API将完整文件导出到所需的文件接收系统。 仅支持临时受众激活 批处理基于文件的目标.

下图说明了通过临时激活API激活受众的端到端工作流，包括每24小时在Platform中执行一次的分段作业。

用例 use-cases

Flash销售或促销

一家在线零售商正准备进行限量闪购，并希望在短时间内通知客户。 通过Experience Platform临时激活API，营销团队可以按需导出受众，并快速向客户群发送促销电子邮件。

当前事件或突发新闻

一家酒店预计未来几天天气会很恶劣，团队希望尽快通知到来的客人，以便他们做出相应计划。 营销团队可以使用Experience Platform临时激活API按需导出受众，并通知来宾。

集成测试

IT经理可以使用Experience Platform临时激活API按需导出受众，以便测试他们与Adobe Experience Platform的自定义集成，并确保一切正常运行。

护栏 guardrails

在使用临时激活API时，请牢记以下护栏。

分段注意事项 segmentation-considerations

Adobe Experience Platform每24小时运行一次计划的分段作业。 临时激活API基于最新的分段结果运行。

步骤1：先决条件 prerequisites

在调用Adobe Experience Platform API之前，请确保您满足以下先决条件：

步骤2：收集身份证明 credentials

要调用Platform API，您必须先完成 身份验证教程. 完成身份验证教程将为所有Experience PlatformAPI调用中的每个所需标头提供值，如下所示：

Experience Platform中的资源可以隔离到特定的虚拟沙箱。 在对Platform API的请求中，您可以指定将执行操作的沙盒的名称和ID。 这些是可选参数。

所有包含有效负载(POST、PUT、PATCH)的请求都需要额外的媒体类型标头：

步骤3：在Platform UI中创建激活流程 activation-flow

在通过临时激活API激活受众之前，您必须首先在平台UI中为所选目标配置激活流程。

这包括进入激活工作流，选择受众，配置计划并激活它们。 您可以使用UI或API创建激活流：

步骤4：获取最新的受众导出作业ID（v2中不需要） segment-export-id

为批处理目标配置激活流后，计划的分段作业每24小时自动运行一次。

在运行临时激活作业之前，必须获取最新受众导出作业的ID。 您必须在临时激活作业请求中传递此ID。

按照描述的说明操作 此处 以检索所有受众导出作业的列表。

在响应中，查找包含下面架构属性的第一个记录。

"schema":{
   "name":"_xdm.context.profile"
}

受众导出作业标识位于 id 属性，如下所示。

步骤5：运行临时激活作业 activation-job

Adobe Experience Platform每24小时运行一次计划的分段作业。 临时激活API基于最新的分段结果运行。

在运行临时激活作业之前，请确保受众的计划受众导出作业已完成。 请参阅 目标数据流监测 有关如何监控激活流状态的信息。 例如，如果激活数据流显示 正在处理 状态，等待它完成后再运行临时激活作业以导出完整文件。

受众导出作业完成后，您可以触发激活。

请求 request

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的请求（将弃用） request-deprecated

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"
   ]
}

响应 response

成功的响应返回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"
      }
   ]
}

API错误处理 api-error-handling

Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码 和 请求标头错误 ，位于平台疑难解答指南中。

特定于ad hoc activation API的API错误代码和消息 specific-error-messages

使用临时激活API时，您可能会遇到特定于此API端点的错误消息。 请查看表格以了解如何在它们出现时解决它们。

相关信息 related-information