评估和访问区段结果

本文档提供了使用Segmentation API评估区段和访问区段结果的教程。

入门指南

本教程要求对创建受众段时涉及的各种Adobe Experience Platform服务有一定的了解。 在开始本教程之前,请查阅以下服务的文档:

所需的标题

本教程还要求您完成身份验证教程,以便成功调用Platform API。 完成身份验证教程后,将为所有Experience Platform API调用中每个所需标头提供值,如下所示:

  • 授权:承载{ACCESS_TOKEN}
  • x-api-key:{API_KEY}
  • x-gw-ims-org-id:{IMS_ORG}

Experience Platform中的所有资源都隔离到特定虚拟沙箱。 对Platform API的请求需要一个头,该头指定操作将在中执行的沙箱的名称:

  • x-sandbox-name:{SANDBOX_NAME}
注意

有关Platform中沙箱的详细信息,请参阅沙箱概述文档

所有POST、PUT和PATCH请求都需要额外的标题:

  • 内容类型:application/json

评估区段

开发、测试和保存区段定义后,您便可以通过计划评估或按需评估来评估区段。

计划评估 (也称为“计划分段”)允许您创建在特定时间运行导出作业的循环计划,而 按需 评估涉及创建区段作业以立即构建受众。下面概述了各步骤。

如果您尚未完成使用分段API教程创建区段或使用区段生成器创建区段定义,请在继续本教程之前执行此操作。

计划评估

通过计划评估,您的IMS组织可以创建循环计划以自动运行导出作业。

注意

对于XDM Individual Profile最多五(5)个合并策略的沙箱,可启用计划评估。 如果您的组织在单个沙箱环境内有5个以上的XDM Individual Profile合并策略,您将无法使用计划的评估。

创建计划

通过向/config/schedules端点发出POST请求,可以创建计划并包含应触发计划的特定时间。

有关使用此端点的详细信息,请参阅计划端点指南

启用计划

默认情况下,创建计划时,除非在create(POST)请求体中将state属性设置为active,否则将处于非活动状态。 您可以通过向/config/schedules端点发出PATCH请求并在路径中包含计划的ID来启用计划(将state设置为active)。

有关使用此端点的详细信息,请参阅计划端点指南

更新计划时间

计划定时可以通过向/config/schedules端点发出PATCH请求并在路径中包含计划的ID来更新。

有关使用此端点的详细信息,请参阅计划端点指南

按需评估

按需评估允许您创建区段作业,以便在需要时生成受众区段。 与计划评估不同,这仅在请求时发生,并且不会重复。

创建区段作业

段作业是创建新受众段的异步进程。 它引用区段定义,以及控制Real-time Customer Profile如何在您的用户档案片段中合并重叠属性的任何合并策略。 当区段作业成功完成时,您可以收集有关区段的各种信息,例如在处理过程中可能发生的任何错误以及受众的最终大小。

可以通过向Real-time Customer Profile API中的/segment/jobs端点发出POST请求来创建新段作业。

有关使用此端点的详细信息,请参阅segment jobs endpoint guide

查找区段作业状态

您可以使用特定区段作业的id执行查找请求(GET),以视图作业的当前状态。

有关使用此端点的详细信息,请参阅segment jobs endpoint guide

解释区段结果

当区段作业成功运行时,segmentMembership映射将针对区段内包含的每个用户档案进行更新。 segmentMembership 还可以存储任何已引入的预评估受众细分, Platform以便与其他解决方案(如 Adobe Audience Manager)集成

以下示例显示每个用户档案记录的segmentMembership属性的外观:

{
  "segmentMembership": {
    "UPS": {
      "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
        "timestamp": "2018-04-26T15:52:25+00:00",
        "status": "existing"
      },
      "53cba6b2-a23b-454a-8069-fc41308f1c0f": {
        "lastQualificationTime": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      }
    },
    "Email": {
      "abcd@adobe.com": {
        "lastQualificationTime": "2017-09-26T15:52:25+00:00",
        "status": "exited"
      }
    }
  }
}
属性 描述
lastQualificationTime 断言区段成员身份和用户档案进入或退出区段的时间戳。
status 作为当前请求一部分的区段参与状态。 必须等于以下已知值之一:
  • existing:实体继续于分类。
  • realized:实体正在进入分部。
  • exited:实体正在退出区段。

访问区段结果

区段作业的结果可通过以下两种方式之一进行访问:您可以访问单个用户档案或将整个受众导出到数据集。

以下几节更详细地概述了这些选项。

查找用户档案

如果您知道要访问的特定用户档案,可以使用Real-time Customer Profile API进行访问。 使用用户档案 API教程访问实时客户用户档案数据中提供了访问各个用户档案的完整步骤。

导出区段

分段作业成功完成后(status属性的值为“SUCCEEDED”),您可以将受众导出到数据集,从中可以访问该数据集并对其执行操作。

导出受众需要执行以下步骤:

创建目标数据集

导出受众时,必须先创建目标数据集。 必须正确配置数据集以确保导出成功。

一个关键注意事项是数据集所基于的模式(schemaRef.id在以下API示例请求中)。 要导出区段,数据集必须基于XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union)。 合并模式是系统生成的只读模式,它聚合共享同一类的模式的字段,在本例中为XDM单个用户档案类。 有关合并视图模式的详细信息,请参阅模式注册开发人员指南🔗的实时客户用户档案部分。

有两种方法可创建必需的数据集:

  • 使用API: 本教程中接下来的步骤概述了如何创建引用使用API XDM Individual Profile Union Schema 的数 Catalog 据集。
  • 使用UI:要 使用用 Adobe Experience Platform 户界面创建引用合并模式的数据集,请按照UI教程中的 骤操作,然后返回本教程,继续执行生成受众用户档案 的步骤

如果您已经有一个兼容用户档案集并知道其ID,则可以直接继续执行生成受众的步骤。

API格式

POST /dataSets

请求

以下请求将创建新数据集,在有效负荷中提供配置参数。

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "Segment Export",
    "schemaRef": {
        "id": "https://ns.adobe.com/xdm/context/profile__union",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    },
    "fileDescription": {
        "persisted": true
    }
}'
属性 描述
name 数据集的描述性名称。
schemaRef.id 合并集将与之关联的视图(模式)的ID。
fileDescription.persisted 一个布尔值,当设置为true时,它使数据集能够在合并视图中保留。

响应

成功的响应返回一个数组,其中包含新创建的数据集的只读、系统生成的唯一ID。 要成功导出受众成员,需要正确配置的数据集ID。

[
  "@/datasets/5b020a27e7040801dedba61b"
] 

为受众成员生成用户档案

一旦有了合并持久数据集,您就可以创建导出作业,通过向Real-time Customer Profile API中的/export/jobs端点发出POST请求并提供要导出的区段的数据集ID和区段信息,将受众成员保留到数据集。

有关使用此端点的详细信息,请参阅导出作业端点指南

监视导出进度

作为导出作业进程,您可以通过向/export/jobs端点发出GET请求并将导出作业的id包含在路径中来监视其状态。 一旦status字段返回值“SUCCEEDED”,导出作业即完成。

有关使用此端点的详细信息,请参阅导出作业端点指南

后续步骤

成功完成导出后,您的数据便可在Experience Platform的Data Lake中使用。 然后,您可以使用与导出关联的batchId访问数据。 Data Access API根据区段的大小,数据可能以块为单位,而批可能由多个文件组成。

有关如何使用Data Access API访问和下载批处理文件的分步说明,请遵循数据访问教程

您还可以使用Adobe Experience Platform Query Service访问成功导出的区段数据。 Query Service使用UI或RESTful API,可以对Data Lake中的数据写入、验证和运行查询。

有关如何查询受众数据的详细信息,请查阅有关Query Service的文档。

在此页面上