Show Menu
主题×

使用API为用户档案和Identity Service配置数据集

本教程介绍了如何启用数据集以用于实时客户用户档案和标识服务的过程,分为以下几步:
  1. 使用以下两个选项之一,启用数据集以在实时客户用户档案中使用:

入门指南

本教程需要了解管理支持用户档案的数据集时涉及的各种Adobe Experience Platform服务。 在开始本教程之前,请查阅以下相关平台服务的文档:
  • 实时客户用户档案 :根据来自多个来源的汇总数据提供统一、实时的消费者用户档案。
  • 标识服务 :通过将来自不同数据源的身份引入平台,实现实时客户用户档案。
  • 目录服务 :一个RESTful API,它允许您创建数据集并为实时客户用户档案和标识服务配置数据集。
  • 体验数据模型(XDM) :平台通过标准化框架组织客户体验数据。
以下各节提供了成功调用平台API所需了解的其他信息。

读取示例API调用

本教程提供示例API调用,以演示如何设置请求的格式。 这些包括路径、必需的标题和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅Experience Platform疑难解答指南 中有关如何阅读示例API调用的部分

收集所需标题的值

要调用平台API,您必须首先完成身份验证 教程 。 完成身份验证教程后,将为所有Experience Platform API调用中的每个所需标头提供值,如下所示:
  • 授权:承载人 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的标头:
  • 内容类型:application/json
Experience Platform中的所有资源都与特定虚拟沙箱隔离。 对平台API的所有请求都需要一个头,它指定操作将在其中进行的沙箱的名称。 有关平台中沙箱的详细信息,请参阅沙 箱概述文档
  • x-sandbox-name: {SANDBOX_NAME}

创建启用了用户档案和标识的数据集

您可以在创建数据集后立即或在创建数据集后的任何点为实时客户用户档案和标识服务启用数据集。 如果要启用已创建的数据集,请按照以下步骤配置此文档 后面找到的现有数据集 。 要创建新数据集,您必须知道为实时客户模式启用的现有XDM用户档案的ID。 有关如何查找或创建支持用户档案的模式的信息,请参阅有关使用 模式注册表API创建模式的教程 。 以下对Catalog API的调用为用户档案和Identity Service启用数据集。
API格式
POST /dataSets

请求
通过在 unifiedProfile unifiedIdentity 求主体 tags 中包含和在下,将立即为用户档案和标识服务启用数据集。 这些标记的值必须是包含字符串的数组 "enabled:true"
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 '{
    "fileDescription" : {
    "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    },
    "fields":[],
    "schemaRef" : {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags" : {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'

属性
描述
schemaRef.id
启用用户档案的模式的ID,数据集将基于该ID。
{TENANT_ID}
模式登记处内的命名空间,其中包含属于您的IMS组织的资源。 有关详细 信息,请参阅模式注册开发人员指南的TENANT_ID
响应
成功的响应会显示一个数组,其中包含以下形式新创建的数据集的ID "@/dataSets/{DATASET_ID}" 。 成功创建并启用数据集后,请继续执行上传数据的 步骤
[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

配置现有数据集

以下步骤介绍如何为实时客户用户档案和标识服务启用先前创建的数据集。 如果您已经创建了启用用户档案的数据集,请继续执行获取数据的 步骤

检查数据集是否已启用

使用Catalog API,您可以检查现有数据集以确定它是否支持在实时客户用户档案和标识服务中使用。 以下调用按ID检索数据集的详细信息。
API格式
GET /dataSets/{DATASET_ID}

参数
描述
{DATASET_ID}
要检查的数据集的ID。
请求
curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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}'

响应
{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "fileDescription": {
            "persisted": true,
            "containerFormat": "parquet",
            "format": "parquet"
        },
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

在属 tags 性下,您可以看到 unifiedProfile unifiedIdentity 都存在该值 enabled:true 。 因此,分别为该数据集启用实时客户用户档案和标识服务。

启用数据集

如果尚未为用户档案或标识服务启用现有数据集,则可以使用数据集ID发出PATCH请求来启用它。
API格式
PATCH /dataSets/{DATASET_ID}

参数
描述
{DATASET_ID}
要更新的数据集的ID。
请求
curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -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 '{
    "tags" : {
        "unifiedProfile": ["enabled:true"],
        "unifiedIdentity": ["enabled:true"]
    }
  }'

请求主体包括一 tags 个属性,该属性包含两个子属性: "unifiedProfile" "unifiedIdentity" 。 这些子属性的值是包含字符串的数组 "enabled:true"
响应 ​成功的PATCH请求会返回HTTP状态200(OK)和一个包含已更新数据集ID的数组。 此ID应与在PATCH请求中发送的ID匹配。 现 "unifiedProfile" 在已添 "unifiedIdentity" 加和标记,并且数据集已启用用户档案和标识服务。
[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

将数据摄取到数据集中

实时客户用户档案和标识服务在将XDM数据摄取到数据集中时都会使用它。 有关如何将数据上传到数据集的说明,请参阅有关使用API 创建数据集的教程 。 在规划要发送到支持用户档案的数据集的数据时,请考虑以下最佳实践:
  • 包括要用作受众段标准的任何数据。
  • 根据您的用户档案数据包含尽可能多的标识符,以最大化标识图。 这使Identity Service能够更高效地跨数据集拼接身份。

确认通过实时客户用户档案获取数据

首次将数据上传到新数据集时,或者作为涉及新ETL或数据源的流程的一部分,建议仔细检查数据,以确保它已按预期上传。 使用实时客户用户档案访问API,您可以在将批量数据加载到数据集中时检索批量数据。 如果无法检索任何您期望的实体,则可能未为实时客户用户档案启用数据集。 确认已启用数据集后,请确保源数据格式和标识符支持您的预期。 有关如何使用实时客户用户档案API访问用户档案数据的详细说明,请按照有关实体的子指南(也称为“用户档案访问API”)进行操作 实体(用户档案访问)

确认由Identity Service摄取数据

摄取的每个包含多个标识的数据片段在您的专用标识图中创建一个链接。 有关标识图和访问标识数据的更多信息,请首先阅读 Identity Service概述