使用分段服务API创建区段定义
本文档提供了有关使用Adobe Experience Platform Segmentation Service API开发、测试、预览和保存区段定义的教程。
有关如何使用用户界面生成区段定义的信息,请参阅区段生成器指南。
快速入门
本教程需要对创建区段定义中涉及的各种Adobe Experience Platform服务有一定的了解。 在开始本教程之前,请查看以下服务的文档:
- Real-Time Customer Profile:根据来自多个源的汇总数据,提供统一的实时使用者个人资料。
- Adobe Experience Platform Segmentation Service:允许您使用区段定义或其他外部源从实时客户档案数据构建受众。
- Experience Data Model (XDM): Platform用于组织客户体验数据的标准化框架。 为了更好地利用分段,请确保根据用于数据建模的最佳实践,将您的数据作为配置文件和事件摄取。
以下部分提供了成功调用Platform API所需了解的其他信息。
正在读取示例 API 调用
本教程提供了示例API调用来演示如何格式化请求。 这些包括路径、必需的标头和格式正确的请求负载。还提供了在 API 响应中返回的示例 JSON。有关示例API调用文档中使用的约定的信息,请参阅Experience Platform疑难解答指南中有关如何读取示例API调用的部分。
收集所需标头的值
要调用Platform API,您必须先完成身份验证教程。 完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值,如下所示:
- 授权:持有人
{ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Experience Platform中的所有资源都被隔离到特定的虚拟沙盒中。 对Platform API的所有请求都需要一个标头,用于指定将在其中执行操作的沙盒的名称:
- x-sandbox-name:
{SANDBOX_NAME}
包含负载 (POST、PUT、PATCH) 的所有请求都需要额外的标头:
- Content-Type: application/json
制定区段定义
分段的第一步是定义区段定义。 区段定义是一个对象,它封装在Profile Query Language (PQL)中编写的查询。 此对象也称为PQL谓词。 PQL谓词根据与您提供给Real-Time Customer Profile的任何记录或时序数据相关的条件定义区段定义的规则。 有关编写PQL查询的更多信息,请参阅PQL指南。
您可以通过向Segmentation API中的/segment/definitions
端点发出POST请求来创建新的区段定义。 以下示例概述了如何设置定义请求的格式,包括成功定义区段定义所需的信息。
有关如何定义区段定义的详细说明,请参阅区段定义开发人员指南。
估计和预览受众 estimate-and-preview-an-audience
在开发区段定义时,您可以使用Real-Time Customer Profile中的估计和预览工具来查看摘要级别的信息,以帮助确保隔离预期受众。 估算提供有关区段定义的统计信息,例如预计受众大小和置信区间。 预览可提供符合区段定义的用户档案的分页列表,以便您将结果与预期结果进行比较。
通过估计和预览受众,您可以测试和优化PQL谓词,直到它们产生所需的结果,然后可以在更新的区段定义中使用它们。
要预览或获取区段定义的估计值,需要执行两个步骤:
如何生成估算
启用实时客户资料的数据被摄取到Platform后,将存储在资料数据存储中。 当将记录摄取到配置文件存储中增加或减少总配置文件计数超过5%时,将触发取样作业以更新计数。 如果配置文件数的变化不超过5%,则取样作业将每周自动运行。
触发示例的方式取决于所使用的摄取类型:
- 对于流数据工作流,会每小时进行一次检查,以确定是否满足了5%的增加或减少阈值。 如果达到此阈值,则会自动触发示例作业以更新计数。
- 对于批量摄取,在成功将批次摄取到配置文件存储区后15分钟内,如果满足5%的增加或减少阈值,则会运行作业以更新计数。 使用配置文件API,您可以预览最新成功的示例作业,以及按数据集和身份命名空间列出配置文件分发。
样本大小取决于配置文件存储中的实体总数。 下表显示了这些样本量:
估计值通常在10-15秒内运行,从粗略估计开始,并随着读取更多记录而优化。
创建预览作业
您可以通过向/preview
端点发出POST请求来创建新的预览作业。
有关创建预览作业的详细说明,请参阅预览和估计端点指南。
查看估计或预览
估算和预览流程是异步运行的,因为不同的查询可能需要不同的时间长度才能完成。 启动查询后,您可以使用API调用在估计或预览的过程中检索(GET)其当前状态。
使用Segmentation Service API,您可以通过预览作业的ID来查找其当前状态。 如果状态为“RESULT_READY”,则可以查看结果。 要查找预览作业的当前状态,请阅读预览和估计端点指南中有关检索预览作业部分的部分。 要查找估算作业的当前状态,请阅读预览和估算端点指南中有关检索估算作业的部分。
后续步骤
开发、测试和保存区段定义后,即可创建区段作业,以使用Segmentation Service API构建受众。 有关如何完成此操作的详细步骤,请参阅有关评估和访问区段结果的教程。