Unions端点

联合（或联合视图）是系统生成的只读架构，用于聚合共享相同类（XDM ExperienceEvent或XDM Individual Profile）并为Real-time Customer Profile启用的所有架构的字段。

本文档介绍了在架构注册表API中与工会合作的基本概念，包括各种操作的示例调用。有关XDM中联合的更多常规信息，请参阅架构组合基础知识中有关联合的部分。

并集架构字段

Schema Registry会自动在并集架构中包含三个关键字段：identityMap、timeSeriesEvents和segmentMembership。

身份映射

并集架构的identityMap是并集关联记录架构内已知标识的表示形式。标识映射将标识分隔为由命名空间键控的不同数组。列出的每个标识本身都是一个包含唯一id值的对象。有关更多信息，请参阅Identity Service文档。

时间系列事件

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

区段成员资格映射

segmentMembership映射存储区段评估的结果。使用分段API成功运行区段作业时，将更新映射。 segmentMembership 此外，还存储了摄取到Platform中的任何预评估受众区段，以便与Adobe Audience Manager等其他解决方案集成。有关更多信息，请参阅有关使用API创建区段的教程。

检索工会列表

在架构上设置union标记后，Schema Registry会自动将架构添加到该架构所依据的类的并集中。如果相关类不存在并集，则会自动创建新并集。并集的$id与其他Schema Registry资源的标准$id类似，唯一的区别在于附加了两个下划线和单词“union”(__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类，其中包含原始的`$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"
        }
    ]
}

查找工会

您可以通过执行包含$id的GET请求来查看特定的并集，并根据Accept标头，查看并集的部分或全部详细信息。

注意

使用/unions和/schemas端点可进行并集查找，以启用它们以在Profile导出到数据集中时使用。

API格式

GET /tenant/unions/{UNION_ID}
GET /tenant/schemas/{UNION_ID}

参数	描述
`{UNION_ID}`	要查找的并集的URL编码的`$id` URI。并集模式的URI将附加“__union”。

请求

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'

并集查找请求要求在Accept标头中包含version。

以下接受标头可用于并集架构查找：

Accept	描述
`application/vnd.adobe.xed+json; version=1`	具有`$ref`和`allOf`的原始数据。包括标题和描述。
`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架构，其中包含原始的`$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"
        }
    }
}

adobe.com 上的资源

Multichannel Communication Targeted Content Triggered Emails Tag Management Audience Targeting Mobile Marketing

Unions端点

并集架构字段

身份映射

时间系列事件

区段成员资格映射

检索工会列表

查找工会

启用联合成员资格的架构

列出并集中的架构

adobe.com 上的资源

在此页面上

查看下一个：

学习

文档

社区

技术支持

资源

Adobe 帐户

Adobe