合并端点

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

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

合并模式字段

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

身份映射

合并模式的identityMap是合并关联记录模式中已知身份的表示。 标识映射将标识分为由命名空间键控的不同数组。 每个列出的标识本身都是包含唯一id值的对象。 有关详细信息,请参阅Identity Service文档

时间系列事件

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

区段成员关系图

segmentMembership映射存储区段评估的结果。 使用分段API成功运行段作业时,将更新映射。 segmentMembership 还存储任何已预评估的受众细分,这些细分被引入平台中,允许与Adobe Audience Manager等其他解决方案集成。有关详细信息,请参阅有关使用API](…/…/segmentation/tutorials/create-a-segment.md)创建区段的教程。[

检索列表合并

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

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

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类,其中包含原始的$refallOf。 (限制: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"
        }
    ]
}

查找合并

您可以通过执行包含$id的GET请求来视图特定合并,并根据“接受”标头,执行合并的部分或全部详细信息。

注意

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

API格式

GET /tenant/unions/{UNION_ID}
GET /tenant/schemas/{UNION_ID}
参数 描述
{UNION_ID} 要查找的合并的URL编码的$id 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=1 具有$refallOf的原始数据。 包括标题和说明。
application/vnd.adobe.xed-full+json; version=1 $ref 属性和已 allOf 解析。包括标题和说明。

响应

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

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

{
    "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)添加到所述模式。 有关详细示例,请参见模式端点指南

列表合并中的模式

要查看哪些模式是特定合并的一部分,可以对/tenant/schemas端点执行GET请求。 使用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模式,其中包含原始$refallOf。 (限制: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"
        }
    }
}

在此页面上

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now