此文档提供了一个教程,介绍如何使用开发、测试、预览和保存区段定义。 Adobe Experience Platform Segmentation Service API.
有关如何使用用户界面构建区段定义的信息,请参阅 区段生成器指南.
本教程需要对各种 Adobe Experience Platform 创建区段定义时涉及的服务。 在开始本教程之前,请查看以下服务的文档:
以下部分提供成功调用 Platform API。
本教程提供了示例API调用来演示如何格式化请求。 这些包括路径、必需的标头和格式正确的请求负载。还提供了在 API 响应中返回的示例 JSON。有关示例 API 调用的文档中使用的惯例信息,请参阅 故障排除指南中的如何读取示例 API 调用Experience Platform。
为调用 Platform API,您必须先完成身份验证教程。完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值,如下所示:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
中的所有资源 Experience Platform 被隔离到特定的虚拟沙盒中。 所有请求 Platform API需要一个标头,该标头应指定将在其中执行操作的沙盒的名称:
{SANDBOX_NAME}
有关中沙箱的详细信息 Platform,请参见 沙盒概述文档.
包含负载 (POST、PUT、PATCH) 的所有请求都需要额外的标头:
分段的第一步是定义区段定义。 区段定义是一个对象,它封装了写入的查询 Profile Query Language (PQL)。 此对象也称为PQL谓词。 PQL谓词根据与您提供给的任何记录或时间序列数据相关的条件定义区段定义的规则 Real-Time Customer Profile. 请参阅 PQL指南 有关编写PQL查询的更多信息。
您可以通过向以下对象发出POST请求来创建新的区段定义: /segment/definitions
中的端点 Segmentation API。 以下示例概述了如何设置定义请求的格式,包括成功定义区段定义所需的信息。
有关如何定义区段定义的详细说明,请参阅 区段定义开发人员指南.
在开发区段定义时,您可以使用中的估算和预览工具 Real-Time Customer Profile 查看摘要级别的信息,以帮助确保隔离预期的受众。 估算提供有关区段定义的统计信息,例如预计受众大小和置信区间。 预览可提供符合区段定义的用户档案的分页列表,以便您将结果与预期结果进行比较。
通过估计和预览受众,您可以测试和优化PQL谓词,直到它们产生所需的结果,然后可以在更新的区段定义中使用它们。
要预览或获取区段定义的估计值,需要执行两个步骤:
数据样本用于评估区段定义并估计符合条件的用户档案的数量。 每天早上(上午12点到凌晨2点,即UTC时间7-9点)将新数据加载到内存中,并使用当天的示例数据来估计所有分段查询。 因此,新增的任何字段或收集的任何额外数据都将反映在第二天的估计数中。
样本大小取决于配置文件存储中的实体总数。 下表显示了这些样本量:
配置文件存储中的实体 | 样本量 |
---|---|
少于100万 | 完整数据集 |
100万到2000万 | 100万 |
超过2000万 | 占总数的5% |
估计值通常在10-15秒内运行,从粗略估计开始,并随着读取更多记录而优化。
您可以通过向以下对象发出POST请求来创建新的预览作业: /preview
端点。
有关创建预览作业的详细说明,请参阅 预览和估计端点指南.
估算和预览流程是异步运行的,因为不同的查询可能需要不同的时间长度才能完成。 启动查询后,您可以使用API调用在估计或预览的过程中检索(GET)其当前状态。
使用 Segmentation Service API中,您可以通过预览作业的ID来查找其当前状态。 如果状态为“RESULT_READY”,则可以查看结果。 要查找预览作业的当前状态,请阅读以下部分: 检索预览作业部分 在预览和估计端点指南中。 要查找估算作业的当前状态,请阅读以下部分: 检索估计作业 在预览和估计端点指南中。
开发、测试和保存区段定义后,即可使用创建区段作业以构建受众。 Segmentation Service API。 请参阅上的教程 评估和访问区段结果 有关如何完成此操作的详细步骤。