为以下项启用数据集 Profile 和 Identity Service 使用API

上次更新: 2023-12-06
  • 主题:
  • Catalog
    查看有关此主题的更多信息
  • 创建对象:
  • Developer
    User
    Admin
    Leader

本教程介绍了启用数据集以用于的过程 Real-Time Customer Profile 和 Identity Service,可划分为以下步骤:

  1. 启用数据集以用于中 Real-Time Customer Profile,使用以下两个选项之一:
  2. 将数据摄取到数据集
  3. 确认通过实时客户资料摄取数据
  4. 确认由Identity服务摄取数据

快速入门

本教程需要对管理启用了配置文件的数据集所涉及的几项Adobe Experience Platform服务有一定的了解。 在开始本教程之前,请查看相关文档 Platform 服务:

  • Real-Time Customer Profile:根据来自多个来源的汇总数据提供统一的实时使用者个人资料。
  • Identity Service:启用 Real-Time Customer Profile 通过桥接来自被摄取到的不同数据源的身份 Platform.
  • Catalog Service:一个RESTful API,允许您为创建数据集并配置它们 Real-Time Customer Profile 和 Identity Service.
  • Experience Data Model (XDM):用于实现此目标的标准化框架 Platform 组织客户体验数据。

以下部分提供了成功调用Platform API所需了解的其他信息。

正在读取示例 API 调用

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

收集所需标头的值

为了调用 Platform API,您必须先完成 身份验证教程. 完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值,如下所示:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

所有包含有效负载(POST、PUT、PATCH)的请求都需要一个额外的 Content-Type 标题。 必要时,此标头的正确值会显示在示例请求中。

中的所有资源 Experience Platform 被隔离到特定的虚拟沙盒中。 所有请求 Platform API需要 x-sandbox-name 用于指定在其中执行操作的沙盒的名称的标头。 有关中沙箱的详细信息 Platform,请参见 沙盒概述文档.

创建为配置文件和身份启用的数据集

您可以在创建数据集后立即或创建数据集后的任何时间点为Real-time Customer Profile和Identity Service启用数据集。 如果要启用已创建的数据集,请按照以下步骤操作 配置现有数据集 可在本文档的后文中找到。

注意

要创建新的启用配置文件的数据集,您必须知道为配置文件启用的现有XDM架构的ID。 有关如何查找或创建启用配置文件的架构的信息,请参阅关于的教程 使用架构注册表API创建架构.

要创建为用户档案启用的数据集,您可以使用POST请求 /dataSets 端点。

API格式

POST /dataSets

请求

通过包含 unifiedProfileunifiedIdentitytags 在请求正文中,将立即为启用数据集 Profile 和 Identity Service、ID名称和ID名称等。 这些标记的值必须是包含字符串的数组 "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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "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 Profile启用数据集的架构。
{TENANT_ID} 中的命名空间 Schema Registry ,其中包含属于您组织的资源。 请参阅 TENANT_ID 的部分 Schema Registry 开发人员指南,以了解更多信息。

响应

成功的响应会显示一个数组,其中包含以形式新建的数据集的ID "@/dataSets/{DATASET_ID}". 成功创建并启用数据集后,请继续执行以下操作的步骤: 上传数据.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

配置现有数据集

以下步骤介绍了如何为启用之前创建的数据集 Real-Time Customer Profile 和 Identity Service. 如果您已经创建了支持配置文件的数据集,请继续执行以下步骤 正在摄取数据.

检查数据集是否已启用

使用 Catalog API时,您可以检查现有数据集以确定是否在中启用它 Real-Time Customer Profile 和 Identity Service. 以下调用将按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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

响应

{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "@/xdms/context/experienceevent",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

tags 属性,您可以看到 unifiedProfileunifiedIdentity 同时存在值 enabled:true. 因此, Real-Time Customer Profile 和 Identity Service 分别为此数据集启用。

启用数据集

如果现有数据集尚未启用 Profile 或 Identity Service,则可以使用数据集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-patch+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/tags/unifiedProfile", "value": ["enabled:true"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

请求正文包括 path 两种类型的标记, unifiedProfileunifiedIdentity. 此 value 每个规则都是包含字符串的数组 enabled:true.

响应

成功的PATCH请求会返回HTTP状态200 (正常)以及包含已更新数据集的ID的数组。 此ID应该与PATCH请求中发送的ID匹配。 此 unifiedProfileunifiedIdentity 现在添加了标记,并启用数据集以供配置文件和Identity服务使用。

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

将数据摄取到数据集

两者 Real-Time Customer Profile 和 Identity Service 使用XDM数据,因为它正在被摄取到数据集中。 有关如何将数据上传到数据集的说明,请参阅关于的教程 使用API创建数据集. 在规划要发送的数据时 Profile启用了的数据集,请考虑以下最佳实践:

  • 包括要用作分段标准的任何数据。
  • 包括可从配置文件数据中确定的任意数量的标识符,以最大化您的身份图。 这允许 Identity Service 以便更有效地拼合数据集之间的身份。

确认数据摄取方式 Real-Time Customer Profile

首次将数据上载到新数据集时,或者作为涉及新ETL或数据源的流程的一部分,建议仔细检查数据,以确保数据已按预期上载。 使用 Real-Time Customer Profile 访问API,您可以在批量数据加载到数据集时检索该数据。 如果无法检索任何预期的实体,则可能无法为启用数据集 Real-Time Customer Profile. 确认已启用数据集后,请确保源数据格式和标识符支持您的期望。 有关如何使用 Real-Time Customer Profile 用于访问的API Profile 有关数据,请参阅 实体端点指南,也称为“Profile Access" API.

确认由Identity服务摄取数据

摄取的每个包含多个身份的数据片段都会在专用身份图中创建链接。 有关身份图形和访问身份数据的更多信息,请首先阅读 Identity服务概述.

在此页面上