結合エンドポイント
結合（または結合ビュー）は、同じクラス （XDM ExperienceEventまたはXDM Individual Profile）を共有し、Real-Time Customer Profileに対して有効になっているすべてのスキーマのフィールドを集計する、システム生成の読み取り専用スキーマです。
このドキュメントでは、Schema Registry API で和集合を操作するための基本的な概念と、様々な操作のサンプル呼び出しを示しています。 XDM の和集合に関する一般的な情報については、スキーマ構成の基本の和集合に関する節を参照してください。
結合スキーマフィールド
Schema Registryには、結合スキーマ内の3つのキーフィールドが自動的に含まれます：identityMap、timeSeriesEvents、segmentMembership。
ID マップ
和集合スキーマの identityMap は、和集合に関連付けられているレコードスキーマ内の既知の ID を表します。 ID マップは、名前空間で特定された異なる配列に ID を分離します。 リストされた各IDは、それ自体が一意のid値を含むオブジェクトです。 詳しくは、ID サービスに関するドキュメントを参照してください。
時系列イベント
timeSeriesEvents 配列は、和集合に関連付けられているレコードスキーマに関連する時系列イベントのリストです。 プロファイルデータがデータセットに書き出されると、この配列は各レコードに含まれます。 これは、様々な使用事例に役立ちます。例えば、モデルがレコード属性に加えてプロファイルの行動履歴全体を必要とする機械学習などに役立ちます。
セグメントメンバーシップマップ
segmentMembership マップには、セグメント定義を評価した結果が格納されます。 Segmentation API を使用してセグメントジョブが正常に実行された場合、マップが更新されます。 segmentMembershipには、Experience Platformに取り込まれた事前評価済みのオーディエンスも保存され、Adobe Audience Managerなどの他のソリューションとの統合が可能になります。 詳しくは、APIを使用したオーディエンスの作成に関するチュートリアルを参照してください。
結合のリストの取得 list
スキーマにunion タグを設定すると、Schema Registryは、スキーマの基になるクラスの結合にスキーマを自動的に追加します。 該当するクラスに和集合が存在しない場合、新しい和集合が自動的に作成されます。 和集合の$idは、他のSchema Registry リソースの標準$idと似ていますが、唯一の違いは、2つのアンダースコアと「和集合」という単語（__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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Accept: application/vnd.adobe.xed-id+json'
応答の形式は、リクエストで送信されたAccept ヘッダーによって異なります。 次のAccept ヘッダーは、結合のリストに使用できます。
Accept ヘッダーapplication/vnd.adobe.xed-id+jsonapplication/vnd.adobe.xed+json$refとallOfを含む、各リソースの完全なJSON クラスを返します。 （上限：300）応答
リクエストが成功した場合は、HTTP ステータス 200（OK）、およびレスポンス本文に results 配列が返されます。 結合が定義されている場合、各結合の詳細は配列内のオブジェクトとして提供されます。 和集合が定義されていない場合も、HTTP ステータス 200（OK）が返されますが、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"
}
]
}
和集合を検索する lookup
特定の和集合を表示するには、$id と、和集合の詳細の一部またはすべて（Accept ヘッダーにより異なる）を含む GET リクエストを実行します。
/unionsおよび/schemas エンドポイントを使用して、データセットへのProfile書き出しで使用できるようにするために使用できます。API 形式
GET /tenant/unions/{UNION_ID}
GET /tenant/schemas/{UNION_ID}
{UNION_ID}$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: {ORG_ID}' \
-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 ヘッダーにより異なります。 異なる 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": {}
}
和集合メンバーシップのスキーマを有効にする enable
スキーマをクラスの和集合に含めるには、スキーマのmeta:immutableTags属性にunion タグを追加する必要があります。 これを実現するには、PATCH リクエストを実行して、該当するスキーマに1つの文字列値unionを持つmeta:immutableTags配列を追加します。 詳細な例については、 スキーマエンドポイントガイド を参照してください。
和集合でのスキーマのリスト list-schemas
どのスキーマが特定の結合の一部であるかを確認するには、/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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答の形式は、リクエストで送信されたAccept ヘッダーによって異なります。 以下のAccept ヘッダーは、スキーマのリストに使用できます。
Accept ヘッダーapplication/vnd.adobe.xed-id+jsonapplication/vnd.adobe.xed+json$refとallOfが含まれている各リソースの完全なJSON スキーマを返します。 （上限：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"
}
}
}