合并端点

合并(或合并视图)是系统生成的只读模式,它聚合共享同一类(或)并启用的所XDM ExperienceEvent 有模式 XDM Individual Profile的字段 Real-time Customer Profile

此文档涵盖在模式注册表API中与合并协作的基本概念,包括各种操作的示例调用。 有关XDM中合并的更多一般信息,请参阅模式合成基 础知识中的合并部分

合并模式字段

在合并 Schema Registry 模式中,自动包括三个关键字段: identityMaptimeSeriesEventssegmentMembership

身份映射

合并 identityMap 模式是合并相关记录模式中已知身份的表示。 标识图将标识分为由命名空间键控的不同数组。 列出的每个标识本身都是包含唯一值的 id 对象。 See the Identity Service documentation for more information.

时间系列事件

timeSeriesEvents 列是与与列表相关联的记录模式相关的时间序列事件的合并。 将用户档案数据导出到数据集时,每个记录都包含此数组。 这对于各种用例都很有用,例如机器学习,其中模型除了记录属性外还需要用户档案的整个行为历史记录。

区段成员关系图

segmentMembership 地图存储分部评估的结果。 使用分段API成功运行段作 业时,将更新映射。 segmentMembership 还存储任何预评估的受众细分,这些细分被引入平台,允许与Adobe Audience Manager等其他解决方案集成。 有关详细信息, 请参阅有关使用API创建 区段的教程。

检索列表合并

在模式上 union 设置标记时, Schema Registry 会自动将模式添加到模式所基于的类的合并。 如果所涉及的类不存在合并,则会自动创建新合并。 合并 $id 的标准与其他资源的标 $id 准相 Schema Registry 似,唯一的区别是附加两个下划线和单词“合并”(__union)。

您可以通过向端点发出GET请求来视图可用合并的 /tenant/unions 列表。

API格式

GET /tenant/unions

请求

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions \
  -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}' \
  -H 'Accept: application/vnd.adobe.xed-id+json'

响应格式取决于在请 Accept 求中发送的标头。 列出合并 Accept 时可使用以下标题:

Accept 标题 描述
application/vnd.adobe.xed-id+json 返回每个资源的简短摘要。 这是列出资源的建议标头。 (限制:300)
application/vnd.adobe.xed+json 为每个资源返回完整的JSON类,其中包含 $ref 原始 allOf 资源。 (限制:300)

响应

成功的响应返回HTTP状态200(OK)和响 results 应主体中的数组。 如果已定义合并,则每个合并的详细信息将作为数组中的对象提供。 如果尚未定义合并,则仍返回HTTP状态200(确定),但数 results 组将为空。

{
    "results": [
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile__union",
            "meta:altId": "_xdm.context.profile__union",
            "version": "1"
        },
        {
            "title": "Property",
            "$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590__union",
            "meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590__union",
            "version": "1"
        }
    ]
}

查找合并

您可以通过执行包含和的视图请求来GET特 $id 定合并,具体取决于“接受”标题,包括合并的部分或全部详细信息。

注意

合并查找可使用 /unions/schemas 端点,以便在导出到数 Profile 据集时使用。

API格式

GET /tenant/unions/{UNION_ID}
GET /tenant/schemas/{UNION_ID}
参数 描述
{UNION_ID} 要查找 $id 的合并的URL编码URI。 合并模式的URI附加“__合并”。

请求

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/unions/https%3A%2F%2Fns.adobe.com%2Fxdm%2Fcontext%2Fprofile__union \
  -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}' \
  -H 'Accept: application/vnd.adobe.xed+json; version=1'

合并查找请求 version 需要包含在Accept头中。

以下接受标题可用于合并模式查找:

接受 描述
application/vnd.adobe.xed+json;version= 原始 $refallOf。 包括标题和说明。
application/vnd.adobe.xed-full+json;version= $ref 属性和已 allOf 解析。 包括标题和说明。

响应

成功的响应返回实现请求路径中提供的类的所有合并 $id 的模式视图。

响应格式取决于请求中发送的接受头。 尝试不同的接受标题以比较响应并确定最适合您的用例的标题。

{
    "type": "object",
    "description": "Union view of all schemas that extend https://ns.adobe.com/xdm/context/profile",
    "allOf": [
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-person-details"
        },
        {
            "$ref": "https://ns.adobe.com/{TENANT_ID}/mixins/477bb01d7125b015b4feba7bccc2e599"
        },
        {
            "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details"
        }
    ],
    "meta:extends": [
        "https://ns.adobe.com/xdm/context/profile",
        "https://ns.adobe.com/xdm/data/record",
        "https://ns.adobe.com/xdm/context/identitymap",
        "https://ns.adobe.com/xdm/common/extensible",
        "https://ns.adobe.com/xdm/common/auditable",
        "https://ns.adobe.com/xdm/context/profile-person-details",
        "https://ns.adobe.com/{TENANT_ID}/mixins/477bb01d7125b015b4feba7bccc2e599",
        "https://ns.adobe.com/xdm/context/profile-personal-details"
    ],
    "title": "Union object for https://ns.adobe.com/xdm/context/profile",
    "$id": "https://ns.adobe.com/xdm/context/profile__union",
    "meta:containerId": "tenant",
    "meta:class": "https://ns.adobe.com/xdm/context/profile",
    "meta:altId": "_xdm.context.profile__union",
    "version": "1.0",
    "meta:resourceType": "unions",
    "meta:registryMetadata": {}
}

启用模式以成为合并会员

要使模式包含在其类的合并中,必须向 union 模式的属性中添加标 meta:immutableTags 记。 为此,可以发出PATCH请求,向所 meta:immutableTags 述模式添加单个字符串值 union 为的数组。 有关详细 的示例 ,请参阅模式端点指南。

列表模式

为了查看哪些模式是特定合并的一部分,您可以对端点执行GET请 /tenant/schemas 求。 使用 property 查询参数,您可以配置响应以仅返回包含字段和等于 meta:immutableTags 您正在访 meta:class 问其合并的类的模式。

API格式

GET /tenant/schemas?property=meta:immutableTags==union&property=meta:class=={CLASS_ID}
参数 描述
{CLASS_ID} $id 合并其启用模式的类的列表。

请求

以下请求检索属于类列表的所有模式的合并 XDM Individual Profile 符。

curl -X GET \
  'https://platform.adobe.io/data/foundation/schemaregistry/tenant/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile' \
  -H 'Accept: application/vnd.adobe.xed-id+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}'

响应格式取决于在请 Accept 求中发送的标头。 列出模式 Accept 时可使用以下标题:

Accept 标题 描述
application/vnd.adobe.xed-id+json 返回每个资源的简短摘要。 这是列出资源的建议标头。 (限制:300)
application/vnd.adobe.xed+json 返回每个资源的完整JSON模式,其中包 $ref 含原始 allOf 资源。 (限制:300)

响应

成功的响应会返回已过滤的模式列表,该仅包含属于已启用合并成员资格的指定类的。 请记住,使用多个查询参数时,会假定AND关系。

{
    "results": [
        {
            "title": "Schema 1",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/142afb78d8b368a5ba97a6cc8fc7e033",
            "meta:altId": "_{TENANT_ID}.schemas.142afb78d8b368a5ba97a6cc8fc7e033",
            "version": "1.2"
        },
        {
            "title": "Schema 2",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/e7297a6ddfc7812ab3a7b504a1ab98da",
            "meta:altId": "_{TENANT_ID}.schemas.e7297a6ddfc7812ab3a7b504a1ab98da",
            "version": "1.5"
        },
        {
            "title": "Schema 3",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/50f960bb810e99a21737254866a477bf",
            "meta:altId": "_{TENANT_ID}.schemas.50f960bb810e99a21737254866a477bf",
            "version": "1.2"
        },
        {
            "title": "Schema 4",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/a39655ca8ea3d5c1f36a463b45fccca8",
            "meta:altId": "_{TENANT_ID}.schemas.a39655ca8ea3d5c1f36a463b45fccca8",
            "version": "1.1"
        },
        {
            "title": "Schema 5",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/c063fac45c6d6285ef33b0e2af09f633",
            "meta:altId": "_{TENANT_ID}.schemas.c063fac45c6d6285ef33b0e2af09f633",
            "version": "1.2"
        },
        {
            "title": "Schema 6",
            "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/dfebb19b93827b70bbad006137812537",
            "meta:altId": "_{TENANT_ID}.schemas.dfebb19b93827b70bbad006137812537",
            "version": "1.7"
        }
    ],
    "_links": {
        "global_schemas": {
            "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/schemas?property=meta:immutableTags==union&property=meta:class==https://ns.adobe.com/xdm/context/profile"
        }
    }
}

在此页面上