文档 Experience Platform Data Ingestion 指南

使用流式引入API流式传输时间序列数据

Last update: Thu May 25 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Data Ingestion

创建对象：

Developer

本教程将帮助您开始使用Adobe Experience Platform中的流摄取API Data Ingestion Service API。

快速入门

本教程需要具备各种Adobe Experience Platform服务的实际操作知识。在开始本教程之前，请查看以下服务的文档：

Experience Data Model (XDM)：用于实现此目标的标准化框架 Platform 组织体验数据。
Real-Time Customer Profile：根据来自多个源的聚合数据实时提供统一的用户配置文件。
Schema Registry开发人员指南：一份全面的指南，涵盖了 Schema Registry API以及如何对它们进行调用。这包括了解 {TENANT_ID}，本教程的调用中都会显示，并且了解如何创建架构，这用于创建摄取数据集。

此外，本教程要求您已创建一个流连接。有关创建流连接的详细信息，请阅读创建流连接教程.

使用平台API

有关如何成功调用Platform API的信息，请参阅 Platform API快速入门.

根据XDM ExperienceEvent类构建架构

要创建数据集，您首先需要创建一个实施 XDM ExperienceEvent 类。有关如何创建架构的更多信息，请阅读架构注册表API开发人员指南.

API格式

POST /schemaregistry/tenant/schemas

请求

curl -X POST https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "type": "object",
    "title": "{SCHEMA_NAME}",
    "description": "{SCHEMA_DESCRIPTION}",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce"
        },
        {
         "$ref":"https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details"
        }
    ],
    "meta:immutableTags": [
        "union"
    ]
}'

属性

描述

title

要用于架构的名称。此名称必须是唯一的。

description

对您创建的架构的有意义描述。

meta:immutableTags

在此示例中， union 标记用于将您的数据持久化到 Real-Time Customer Profile.

响应

成功响应会返回HTTP状态201以及新创建架构的详细信息。

{
    "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
    "meta:altId": "_{TENANT_ID}.schemas.{SCHEMA_ID}",
    "meta:resourceType": "schemas",
    "version": "1",
    "type": "object",
    "title": "{SCHEMA_NAME}",
    "description": "{SCHEMA_DESCRIPTION}",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce",
            "type": "object",
            "meta:xdmType": "object"
        },
        {
            "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details",
            "type": "object",
            "meta:xdmType": "object"
        }
    ],
    "refs": [
        "https://ns.adobe.com/xdm/context/experienceevent-commerce",
        "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details",
        "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
        "https://ns.adobe.com/xdm/context/experienceevent"
    ],
    "imsOrg": "{ORG_ID}",
    "meta:immutableTags": [
        "union"
    ],
    "meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
    "required": [
        "@id",
        "xdm:timestamp"
    ],
    "meta:abstract": false,
    "meta:extensible": false,
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/experienceevent",
        "https://ns.adobe.com/xdm/data/time-series",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/xdm/context/experienceevent-environment-details",
        "https://ns.adobe.com/xdm/context/experienceevent-commerce",
        "https://ns.adobe.com/experience/campaign/experienceevent-profile-work-details"
    ],
    "meta:containerId": "tenant",
    "imsOrg": "{ORG_ID}",
    "meta:xdmType": "object",
    "meta:class": "https://ns.adobe.com/xdm/context/experienceevent",
    "meta:registryMetadata": {
        "repo:createDate": 1551229957987,
        "repo:lastModifiedDate": 1551229957987,
        "xdm:createdClientId": "{CLIENT_ID}",
        "xdm:repositoryCreatedBy": "{CREATED_BY}"
    },
    "meta:tenantNamespace": "{NAMESPACE}"
}

属性

描述

{TENANT_ID}

此ID用于确保您创建的资源被正确命名并包含在您的组织中。有关租户ID的更多信息，请阅读模式注册表指南.

请记下 $id 以及 version 属性，因为创建数据集时将同时使用这两个属性。

为架构设置主标识描述符

接下来，添加身份描述符以上创建的模式，使用工作电子邮件地址属性作为主要标识符。执行此操作将导致两个更改：

工作电子邮件地址将成为必填字段。这意味着在没有此字段的情况下发送的邮件将验证失败并且不会被摄取。
Real-Time Customer Profile 将使用工作电子邮件地址作为标识符以帮助拼合有关该个人的更多信息。

请求

curl -X POST https://platform.adobe.io/data/foundation/schemaregistry/tenant/descriptors \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "@type":"xdm:descriptorIdentity",
    "xdm:sourceProperty":"/_experience/campaign/message/profileSnapshot/workEmail/address",
    "xdm:property":"xdm:code",
    "xdm:isPrimary":true,
    "xdm:namespace":"Email",
    "xdm:sourceSchema":"{SCHEMA_REF_ID}",
    "xdm:sourceVersion":1
}

属性

描述

{SCHEMA_REF_ID}

此 $id 您之前在撰写架构时收到的内容。它应该看起来像这样： "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}"

NOTE

身份命名空间代码

请确保代码有效 — 上面的示例使用“email”，它是一个标准身份命名空间。其他常用的标准身份命名空间可在中找到 Identity服务常见问题解答.

如果要创建自定义命名空间，请按照身份命名空间概述.

响应

成功的响应返回HTTP状态201，其中包含有关新创建的主要身份命名空间的信息。

{
    "xdm:property": "xdm:code",
    "xdm:sourceSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
    "xdm:namespace": "Email",
    "@type": "xdm:descriptorIdentity",
    "xdm:sourceVersion": 1,
    "xdm:isPrimary": true,
    "xdm:sourceProperty": "/_experience/campaign/message/profileSnapshot/workEmail/address",
    "@id": "ec31c09e0906561861be5a71fcd964e29ebe7923b8eb0d1e",
    "meta:containerId": "tenant",
    "version": "1",
    "imsOrg": "{ORG_ID}"
}

为时间序列数据创建数据集

创建架构后，您将需要创建一个数据集来摄取记录数据。

NOTE

此数据集将启用 Real-Time Customer Profile 和 Identity 通过设置适当的标记。

API格式

POST /catalog/dataSets

请求

curl -X POST https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "{DATASET_NAME}",
    "description": "{DATASET_DESCRIPTION}",
    "schemaRef": {
        "id": "{SCHEMA_REF_ID}",
        "contentType": "application/vnd.adobe.xed-full+json;version=1"
    },
    "tags": {
        "unifiedIdentity": ["enabled:true"],
        "unifiedProfile": ["enabled:true"]
    }
}'

响应

成功的响应会返回HTTP状态201和一个数组，该数组包含格式中新创建的数据集的ID @/dataSets/{DATASET_ID}.

[
    "@/dataSets/5e72608b10f6e318ad2dee0f"
]

创建流连接

创建架构和数据集后，您将需要创建一个流连接来摄取数据。

有关创建流连接的详细信息，请阅读创建流连接教程.

将时间序列数据摄取到流连接

在创建数据集、流连接和数据流后，您可以摄取XDM格式的JSON记录以摄取中的时序数据 Platform.

API格式

POST /collection/{CONNECTION_ID}?syncValidation=true

参数

描述

{CONNECTION_ID}

此 id 新创建的流连接的值。

syncValidation

用于开发目的的可选查询参数。如果设置为 true，它可用于即时反馈以确定请求是否已成功发送。默认情况下，此值设置为 false. 请注意，如果您将此查询参数设置为 true 请求速率将限制为每分钟60次 CONNECTION_ID.

请求

可以将时间序列数据摄取到流连接，无论是否使用源名称。

下面的示例请求将缺少源名称的时间系列数据摄取到Platform。如果数据缺少源名称，它将从流连接定义中添加源ID。

两者 xdmEntity._id 和 xdmEntity.timestamp 是时间序列数据的必填字段。此 xdmEntity._id 属性表示记录本身的唯一标识符，非其记录所属的人员或设备的唯一ID。

您需要生成自己的 xdmEntity._id 和 xdmEntity.timestamp 以保持一致的方式获取记录，以便将来需要重新获取记录。理想情况下，源系统将包含这些值。如果ID不可用，请考虑关联记录中其他字段的值以创建一个唯一值，该值可在重新摄取时始终从记录中重新生成。

NOTE

以下API调用执行非需要任何身份验证标头。

curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
  -H "Content-Type: application/json" \
  -d '{
    "header": {
        "schemaRef": {
            "id": "{SCHEMA_REF_ID}",
            "contentType": "application/vnd.adobe.xed-full+json;version=1"
        },
        "flowId": "{FLOW_ID}",
        "datasetId": "{DATASET_ID}"
    },
    "body": {
        "xdmMeta": {
            "schemaRef": {
                "id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
                "contentType": "application/vnd.adobe.xed-full+json;version=1"
            },
        "identityMap": {
                "Email": [
                  {
                    "id": "acme_user@gmail.com",
                    "primary": true
                  }
                ]
              },
        },
        "xdmEntity":{
            "_id": "9af5adcc-db9c-4692-b826-65d3abe68c22",
            "timestamp": "2019-02-23T22:07:01Z",
            "environment": {
                "browserDetails": {
                    "userAgent": "Mozilla\/5.0 (Windows NT 5.1) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/29.0.1547.57 Safari\/537.36 OPR\/16.0.1196.62",
                    "acceptLanguage": "en-US",
                    "cookiesEnabled": true,
                    "javaScriptVersion": "1.6",
                    "javaEnabled": true
                },
                "colorDepth": 32,
                "viewportHeight": 799,
                "viewportWidth": 414
            },
            "productListItems": [
                {
                    "SKU": "CC",
                    "name": "Fernie Snow",
                    "quantity": 30,
                    "priceTotal": 7.8
                }
            ],
            "commerce": {
                "productViews": {
                    "value": 1
                }
            },
            "_experience": {
                "campaign": {
                    "message": {
                        "profileSnapshot": {
                            "workEmail":{
                                "address": "janedoe@example.com"
                            }
                        }
                    }
                }
            }
        }
    }
}'

如果要包含源名称，以下示例显示如何包含该源名称。

    "header": {
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
            "contentType": "application/vnd.adobe.xed-full+json;version=1"
        },
        "imsOrgId": "{ORG_ID}",
        "datasetId": "{DATASET_ID}",
        "source": {
            "name": "Sample source name"
        }
    }

响应

成功的响应返回HTTP状态200，其中包含新流式传输的详细信息 Profile.

{
    "inletId": "{CONNECTION_ID}",
    "xactionId": "1584479347507:2153:240",
    "receivedTimeMs": 1584479347507,
    "syncValidation": {
        "status": "pass"
    }
}

属性

描述

{CONNECTION_ID}

此 inletId 之前创建的流连接的ID。

xactionId

在服务器端为您刚刚发送的记录生成的唯一标识符。此ID有助于Adobe通过各种系统和调试，跟踪此记录的生命周期。

receivedTimeMs：显示收到请求的时间的时间的时间戳（以毫秒为单位）。

syncValidation.status

由于查询参数 syncValidation=true 添加，将显示此值。如果验证成功，则状态将为 pass.

检索新摄取的时间系列数据

要验证以前摄取的记录，您可以使用 Profile Access API 以检索时间序列数据。这可以通过向发出的GET请求来完成 /access/entities 端点并使用可选的查询参数。可以使用多个参数，以&分隔。”

NOTE

如果未定义合并策略ID，并且 schema.name 或 relatedSchema.name 是 _xdm.context.profile， Profile Access 将获取所有相关身份。

API格式

GET /access/entities
GET /access/entities?{QUERY_PARAMETERS}
GET /access/entities?schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=janedoe@example.com&relatedEntityIdNS=email

参数

描述

schema.name

必需。 您正在访问的架构的名称。

relatedSchema.name

必需。 由于您正在访问 _xdm.context.experienceevent，此值指定与时序事件相关的配置文件实体的架构。

relatedEntityId

相关实体的ID。如果提供，则还必须提供实体命名空间。

relatedEntityIdNS

您尝试检索的ID的命名空间。

请求

curl -X GET \
  https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.experienceevent&relatedSchema.name=_xdm.context.profile&relatedEntityId=janedoe@example.com&relatedEntityIdNS=email \
  -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}"

响应

成功的响应返回HTTP状态200，其中包含所请求实体的详细信息。如您所见，这与之前摄取的时间序列数据相同。

{
    "_page": {
        "orderby": "timestamp",
        "start": "9af5adcc-db9c-4692-b826-65d3abe68c22",
        "count": 1,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
            "entityId": "9af5adcc-db9c-4692-b826-65d3abe68c22",
            "timestamp": 1582495621000,
            "entity": {
                "environment": {
                    "browserDetails": {
                        "javaScriptVersion": "1.6",
                        "cookiesEnabled": true,
                        "userAgent": "Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/29.0.1547.57 Safari/537.36 OPR/16.0.1196.62",
                        "acceptLanguage": "en-US",
                        "javaEnabled": true
                    },
                    "colorDepth": 32,
                    "viewportHeight": 799,
                    "viewportWidth": 414
                },
                "_id": "9af5adcc-db9c-4692-b826-65d3abe68c22",
                "commerce": {
                    "productViews": {
                        "value": 1
                    }
                },
                "productListItems": [
                    {
                        "name": "Fernie Snow",
                        "quantity": 30,
                        "SKU": "CC",
                        "priceTotal": 7.8
                    }
                ],
                "_experience": {
                    "campaign": {
                        "message": {
                            "profileSnapshot": {
                                "workEmail": {
                                    "address": "janedoe@example.com"
                                }
                            }
                        }
                    }
                },
                "timestamp": "2020-02-23T22:07:01Z"
            },
            "lastModifiedAt": "2020-03-18T18:51:19Z"
        }
    ],
    "_links": {
        "next": {
            "href": ""
        }
    }
}

后续步骤

通过阅读本文档，您现在了解了如何将记录数据摄取到 Platform 使用流连接。您可以尝试使用不同的值发出更多调用并检索更新的值。此外，您还可以开始通过监视引入的数据 Platform UI。欲知更多信息，请阅读监测数据摄取指南。

有关一般流式摄取的更多信息，请阅读流式摄取概述.

recommendation-more-help

2ee14710-6ba4-4feb-9f79-0aad73102a9a