ドキュメント Experience Platform エクスペリエンスデータモデル（XDM）ガイド

クラスエンドポイント

最終更新日： 2026年6月16日

トピック：
{"id":"c132d929-fa62-4271-803e-b823be07b914"}

作成対象：

{"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

すべてのExperience Data Model （XDM）スキーマは、クラスに基づいている必要があります。クラスは、そのクラスに基づくすべてのスキーマに含める必要がある共通プロパティの基本構造と、それらのスキーマで使用できるスキーマフィールドグループを決定します。さらに、スキーマのクラスは、スキーマに含まれるデータの行動的側面を決定します。このデータには、次の2つのタイプがあります。

レコード：主体の属性に関する情報を提供します。主体は、組織または個人にすることができます。
時系列: レコードの被写体によって直接または間接的にアクションが実行された時点のシステムのスナップショットを提供します。

NOTE

データ動作がスキーマ構成に与える影響に関する詳細なクラスについては、スキーマ構成の基本を参照してください。

Schema Registry APIの/classes エンドポイントを使用すると、エクスペリエンスアプリケーション内のクラスをプログラムで管理できます。

はじめに

このガイドで使用されているエンドポイントは、Schema Registry APIの一部です。先に進む前に、はじめる前にを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。

クラスのリストの取得 list

globalまたはtenant コンテナの下にあるすべてのクラスを一覧表示するには、それぞれ/global/classesまたは/tenant/classesにGET リクエストを行います。

NOTE

リソースを一覧表示する場合、Schema Registryは結果セットを300項目に制限します。この制限を超えるリソースを返すには、ページングパラメーターを使用する必要があります。また、結果をフィルタリングし、返されるリソースの数を減らすために、追加のクエリパラメーターを使用することをお勧めします。詳しくは、付録ドキュメントのクエリパラメーターの節を参照してください。

API 形式

GET /{CONTAINER_ID}/classes?{QUERY_PARAMS}

パラメーター

説明

{CONTAINER_ID}

Adobeが作成したクラスのglobalまたは自社が所有するクラスのtenantからクラスを取得するコンテナ。

{QUERY_PARAMS}

結果をフィルタリングする条件となるクエリパラメーター（オプション）。使用可能なパラメーターのリストについては、付録ドキュメントを参照してください。

リクエスト

次のリクエストは、orderby クエリパラメーターを使用して、tenant コンテナからクラスのリストを取得し、title属性でクラスを並べ替えます。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes?orderby=title \
  -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+json

各リソースの短いサマリーを返します。リソースを一覧表示する際に推奨されるヘッダーです。（上限：300）

application/vnd.adobe.xed+json

元の$refとallOfを含む、各リソースの完全なJSON クラスを返します。（上限：300）

応答

上記のリクエストではapplication/vnd.adobe.xed-id+json Accept ヘッダーが使用されていたため、応答には、各クラスのtitle、$id、meta:altIdおよびversion属性のみが含まれています。他のAccept ヘッダー（application/vnd.adobe.xed+json）を使用すると、各クラスのすべての属性が返されます。応答に必要な情報に応じて、適切なAccept ヘッダーを選択します。

{
  "results": [
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/classes/01b7b1745e8ac4ed1e8784ec91b6afa7",
      "meta:altId": "_{TENANT_ID}.classes.01b7b1745e8ac4ed1e8784ec91b6afa7",
      "version": "1.0",
      "title": "Hotel"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/classes/d43b86253676af50da3f671ecdd26ff9",
      "meta:altId": "_{TENANT_ID}.classes.d43b86253676af50da3f671ecdd26ff9",
      "version": "1.1",
      "title": "Property"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/classes/366f015dbfea802455fbc46c3b27f771",
      "meta:altId": "_{TENANT_ID}.classes.366f015dbfea802455fbc46c3b27f771",
      "version": "1.0",
      "title": "Subscription"
    }
  ],
  "_page": {
    "orderby": "title",
    "next": null,
    "count": 3
  },
  "_links": {
    "next": null,
    "global_schemas": {
      "href": "https://platform.adobe.io/data/foundation/schemaregistry/global/classes"
    }
  }
}

クラスを検索する lookup

GET リクエストのパスにクラスのIDを含めることで、特定のクラスを検索できます。

API 形式

GET /{CONTAINER_ID}/classes/{CLASS_ID}

パラメーター

説明

{CONTAINER_ID}

取得するクラスを格納するコンテナ：Adobeで作成されたクラスのglobal、または組織が所有するクラスのtenant。

{CLASS_ID}

検索するクラスのmeta:altIdまたはURL エンコードされた$idです。

リクエスト

次のリクエストは、パスで指定されたmeta:altId値でクラスを取得します。

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.f579a0b5f992c69458ea408ec36571f7da9de15901bab116 \
  -H 'Accept: application/vnd.adobe.xed+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 ヘッダーによって異なります。すべてのルックアップリクエストでは、versionをAccept ヘッダーに含める必要があります。次のAccept ヘッダーを使用できます。

Accept ヘッダー

説明

application/vnd.adobe.xed+json; version=1

$ref および allOf で生、タイトルと説明を含む

application/vnd.adobe.xed-full+json; version=1

$ref および allOf を解決、タイトルと説明を含む

application/vnd.adobe.xed-notext+json; version=1

$ref および allOf で生、タイトルや説明なし

application/vnd.adobe.xed-full-notext+json; version=1

$ref および allOf で解決、タイトルや説明なし

application/vnd.adobe.xed-full-desc+json; version=1

$ref および allOf で解決、説明を含む

応答

応答が成功すると、クラスの詳細が返されます。返されるフィールドは、リクエストで送信されたAccept ヘッダーによって異なります。様々なAccept ヘッダーを試して、回答を比較し、どのヘッダーがユースケースに最適かを判断します。

{
  "$id":"https://ns.adobe.com/{TENANT_ID}/classes/f8bbdc3c49d49eae62d1c17e867230ac3de6b5b63b0615ce",
  "meta:altId":"_{TENANT_ID}.classes.f8bbdc3c49d49eae62d1c17e867230ac3de6b5b63b0615ce",
  "meta:resourceType":"classes",
  "version":"1.1",
  "title":"Hotel",
  "type":"object",
  "description":"Base class for the Hotels schema",
  "definitions":{
    "customFields":{
      "type":"object",
      "properties":{
        "_{TENANT_ID}":{
          "type":"object",
          "properties":{
            "Address":{
              "title":"Address",
              "description":"",
              "isRequired":false,
              "$ref":"https://ns.adobe.com/xdm/common/address",
              "type":"object",
              "meta:xdmType":"object"
            },
            "phoneNumber":{
              "title":"Phone Number",
              "description":"",
              "isRequired":false,
              "$ref":"https://ns.adobe.com/xdm/context/phonenumber",
              "type":"object",
              "meta:xdmType":"object"
            },
            "brand":{
              "title":"Brand",
              "description":"",
              "type":"string",
              "isRequired":false,
              "meta:xdmType":"string"
            },
            "hotelId":{
              "title":"Hotel ID",
              "description":"",
              "type":"string",
              "isRequired":false,
              "meta:xdmType":"string"
            }
          },
          "meta:xdmType":"object"
        }
      },
      "meta:xdmType":"object"
    }
  },
  "allOf":[
    {
      "$ref":"https://ns.adobe.com/xdm/data/record",
      "type":"object",
      "meta:xdmType":"object"
    },
    {
      "$ref":"#/definitions/customFields",
      "type":"object",
      "meta:xdmType":"object"
    }
  ],
  "imsOrg":"{ORG_ID}",
  "meta:extensible":true,
  "meta:abstract":true,
  "meta:extends":[
    "https://ns.adobe.com/xdm/data/record"
  ],
  "meta:xdmType":"object",
  "meta:registryMetadata":{
    "repo:createdDate":1593643258779,
    "repo:lastModifiedDate":1597246362579,
    "xdm:createdClientId":"{CLIENT_ID}",
    "xdm:lastModifiedClientId":"{CLIENT_ID}",
    "xdm:createdUserId":"{USER_ID}",
    "xdm:lastModifiedUserId":"{USER_ID}",
    "eTag":"502f89ee16b8ab2e6b4ea09ecf0ab1e5614907db755051c1f3c65a273001d725",
    "meta:globalLibVersion":"1.15.4"
  },
  "meta:containerId":"tenant",
  "meta:tenantNamespace":"_{TENANT_ID}"
}

クラスの作成 create

POST リクエストを行うことで、tenant コンテナの下にカスタムクラスを定義できます。

IMPORTANT

定義したカスタムクラスに基づいてスキーマを作成する場合、標準フィールドグループを使用することはできません。各フィールドグループは、互換性のあるクラスをmeta:intendedToExtend属性で定義します。新しいクラスと互換性のあるフィールドグループの定義を開始すると（フィールドグループのmeta:intendedToExtend フィールドで新しいクラスの$idを使用することで）、定義したクラスを実装するスキーマを定義するたびに、それらのフィールドグループを再利用できるようになります。詳しくは、それぞれのエンドポイントガイドのフィールドグループの作成およびスキーマの作成に関する節を参照してください。

Real-Time Customer Profileでカスタムクラスに基づくスキーマを使用する場合は、結合スキーマは同じクラスを共有するスキーマのみに基づいて構築されることにも注意してください。 XDM Individual ProfileまたはXDM ExperienceEventのような別のクラスの結合にカスタムクラススキーマを含める場合は、そのクラスを使用する別のスキーマとの関係を確立する必要があります。詳しくは、APIで2つのスキーマ間の関係を確立するに関するチュートリアルを参照してください。

API 形式

POST /tenant/classes

リクエスト

クラスを作成する（POST）リクエストには、https://ns.adobe.com/xdm/data/record または https://ns.adobe.com/xdm/data/time-series の 2 つの値のいずれかへの $ref を含む allOf 属性を含める必要があります。これらの値は、クラスの基となる動作（レコードまたは時系列）を表します。レコードデータと時系列データの違いについて詳しくは、「スキーマ構成の基本」内の動作タイプに関する節を参照してください。

クラスを定義する場合、クラス定義内にフィールドグループまたはカスタムフィールドを含めることもできます。これにより、追加されたフィールドグループとフィールドが、クラスを実装するすべてのスキーマに含まれるようになります。次のリクエスト例では、「Property」と呼ばれるクラスを定義しています。このクラスは、会社が所有および操作する様々なプロパティに関する情報を取得します。クラスが使用されるたびに含める propertyId フィールドが含まれます。

curl -X POST \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes \
  -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 '{
        "title":"Property",
        "description":"Properties owned and operated by the company.",
        "type":"object",
        "definitions": {
          "property": {
            "properties": {
              "_{TENANT_ID}": {
                "type": "object",
                "properties": {
                  "property": {
                    "title": "Property Information",
                    "type": "object",
                    "description": "Information about different owned and operated properties.",
                    "properties": {
                      "propertyId": {
                        "title": "Property Identification Number",
                        "type": "string",
                        "description": "Unique Property identification number"
                      }
                    }
                  }
                }
              }
            },
            "type": "object"
          }
        },
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/xdm/data/record"
          },
          {
            "$ref": "#/definitions/property"
          }
        ]
      }'

プロパティ

説明

_{TENANT_ID}

組織の TENANT_ID 名前空間。組織によって作成されたすべてのリソースには、Schema Registry内の他のリソースとの競合を避けるために、このプロパティを含める必要があります。

allOf

新しいリストによってプロパティが継承されるリソースのクラス。配列内の $ref オブジェクトの 1 つが、クラスの動作を定義します。この例では、クラスは「レコード」動作を継承します。

応答

正常な応答は、HTTP ステータス 201（作成済み）と、新しく作成されたクラスの詳細（$id、meta:altId、version）を含むペイロードを返します。これらの3つの値は読み取り専用で、Schema Registryによって割り当てられます。

{
  "title": "Property",
  "description": "Properties owned and operated by the company.",
  "type": "object",
  "definitions": {
    "property": {
      "properties": {
        "_{TENANT_ID}": {
          "type": "object",
          "properties": {
            "property": {
              "title": "Property Information",
              "type": "object",
              "description": "Information about different owned and operated properties.",
              "properties": {
                "propertyId": {
                  "title": "Property Identification Number",
                  "type": "string",
                  "description": "Unique Property identification number",
                  "meta:xdmType": "string"
                }
              },
              "meta:xdmType": "object"
            }
          },
          "meta:xdmType": "object"
        }
      },
      "type": "object",
      "meta:xdmType": "object"
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/data/record"
    },
    {
      "$ref": "#/definitions/property"
    }
  ],
  "meta:abstract": true,
  "meta:extensible": true,
  "meta:extends": [
    "https://ns.adobe.com/xdm/data/record"
  ],
  "meta:containerId": "tenant",
  "imsOrg": "{ORG_ID}",
  "meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590",
  "meta:xdmType": "object",
  "$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
  "version": "1.0",
  "meta:resourceType": "classes",
  "meta:registryMetadata": {
    "repo:createDate": 1552086405448,
    "repo:lastModifiedDate": 1552086405448,
    "xdm:createdClientId": "{CREATED_CLIENT}",
    "xdm:repositoryCreatedBy": "{CREATED_BY}"
  }
}

tenant コンテナ内のすべてのクラス 🔗をリストにGET リクエストを実行すると、プロパティクラスが含まれるようになりました。また、URL エンコードされた$idを使用してルックアップ（GET）リクエストを実行し、新しいクラスを直接表示することもできます。

クラスの更新 put

PUT操作を通じてクラス全体を置き換え、基本的にリソースを書き換えることができます。 PUT リクエストを通じてクラスを更新する場合、本文には、POST リクエストで新しいクラスを作成するときに必要なすべてのフィールドを含める必要があります。

NOTE

クラスの一部を完全に置き換えるのではなく更新するだけの場合は、クラスの一部の更新の節を参照してください。

API 形式

PUT /tenant/classes/{CLASS_ID}

パラメーター

説明

{CLASS_ID}

書き換えるクラスのmeta:altIdまたはURL エンコードされた$idです。

リクエスト

次のリクエストは、既存のクラスを書き換え、そのdescriptionとそのフィールドのtitleを変更します。

curl -X PUT \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590 \
  -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 '{
        "title": "Property",
        "description": "Base class for properties operated by a company.",
        "type": "object",
        "definitions": {
          "property": {
            "properties": {
              "_{TENANT_ID}": {
                "type": "object",
                "properties": {
                  "property": {
                    "title": "Property Information",
                    "type": "object",
                    "description": "Information about different owned and operated properties.",
                    "properties": {
                      "propertyId": {
                        "title": "Property ID",
                        "type": "string",
                        "description": "Unique Property ID string."
                      }
                    }
                  }
                }
              }
            },
            "type": "object"
          }
        },
        "allOf": [
          {
            "$ref": "https://ns.adobe.com/xdm/data/record"
          },
          {
            "$ref": "#/definitions/property"
          }
        ]
      }'

応答

応答が成功すると、更新されたクラスの詳細が返されます。

{
  "title": "Property",
  "description": "Base class for properties operated by a company.",
  "type": "object",
  "definitions": {
    "property": {
      "properties": {
        "_{TENANT_ID}": {
          "type": "object",
          "properties": {
            "property": {
              "title": "Property Information",
              "type": "object",
              "description": "Information about different owned and operated properties.",
              "properties": {
                "propertyId": {
                  "title": "Property ID",
                  "type": "string",
                  "description": "Unique Property ID string",
                  "meta:xdmType": "string"
                }
              },
              "meta:xdmType": "object"
            }
          },
          "meta:xdmType": "object"
        }
      },
      "type": "object",
      "meta:xdmType": "object"
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/data/record"
    },
    {
      "$ref": "#/definitions/property"
    }
  ],
  "meta:abstract": true,
  "meta:extensible": true,
  "meta:extends": [
    "https://ns.adobe.com/xdm/data/record"
  ],
  "meta:containerId": "tenant",
  "imsOrg": "{ORG_ID}",
  "meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590",
  "meta:xdmType": "object",
  "$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
  "version": "1.0",
  "meta:resourceType": "classes",
  "meta:registryMetadata": {
    "repo:createDate": 1552086405448,
    "repo:lastModifiedDate": 1552086405448,
    "xdm:createdClientId": "{CREATED_CLIENT}",
    "xdm:repositoryCreatedBy": "{CREATED_BY}"
  }
}

クラスの一部を更新する patch

PATCH リクエストを使用すると、クラスの一部を更新できます。 Schema Registryは、add、removeおよびreplaceを含むすべての標準JSON パッチ操作をサポートしています。 JSON パッチについて詳しくは、API の基本ガイドを参照してください。

NOTE

個々のフィールドを更新する代わりに、リソース全体を新しい値に置き換える場合は、PUT操作を使用したクラスの置き換えの節を参照してください。

API 形式

PATCH /tenant/class/{CLASS_ID}

パラメーター

説明

{CLASS_ID}

更新するクラスのURL エンコードされた$id URIまたはmeta:altId。

リクエスト

以下のリクエスト例では、既存のクラスのdescriptionと、そのフィールドのtitleを更新しています。

リクエスト本文は配列の形式を取り、各リストオブジェクトは個々のフィールドに対する特定の変更を表します。各オブジェクトには、実行する操作（op）、操作を実行するフィールド（path）、その操作（value）に含める情報が含まれます。

curl -X PATCH \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590 \
  -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 'content-type: application/json' \
  -d '[
        { "op": "replace", "path": "/description", "value":  "Base class for properties operated by a company."},
        { "op": "replace", "path": "/definitions/property/properties/_{TENANT_ID}/properties/property/properties/propertyId/title", "value": "Unique Property ID string" }
      ]'

応答

応答には、両方の操作が正常に実行されたことが示されます。 descriptionが更新され、propertyId フィールドのtitleも更新されました。

{
  "title": "Property",
  "description": "Base class for properties operated by a company.",
  "type": "object",
  "definitions": {
    "property": {
      "properties": {
        "_{TENANT_ID}": {
          "type": "object",
          "properties": {
            "property": {
              "title": "Property Information",
              "type": "object",
              "description": "Information about different owned and operated properties.",
              "properties": {
                "propertyId": {
                  "title": "Property ID",
                  "type": "string",
                  "description": "Unique Property ID string",
                  "meta:xdmType": "string"
                }
              },
              "meta:xdmType": "object"
            }
          },
          "meta:xdmType": "object"
        }
      },
      "type": "object",
      "meta:xdmType": "object"
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/data/record"
    },
    {
      "$ref": "#/definitions/property"
    }
  ],
  "meta:abstract": true,
  "meta:extensible": true,
  "meta:extends": [
    "https://ns.adobe.com/xdm/data/record"
  ],
  "meta:containerId": "tenant",
  "imsOrg": "{ORG_ID}",
  "meta:altId": "_{TENANT_ID}.classes.19e1d8b5098a7a76e2c10a81cbc99590",
  "meta:xdmType": "object",
  "$id": "https://ns.adobe.com/{TENANT_ID}/classes/19e1d8b5098a7a76e2c10a81cbc99590",
  "version": "1.0",
  "meta:resourceType": "classes",
  "meta:registryMetadata": {
    "repo:createDate": 1552086405448,
    "repo:lastModifiedDate": 1552086405448,
    "xdm:createdClientId": "{CREATED_CLIENT}",
    "xdm:repositoryCreatedBy": "{CREATED_BY}"
  }
}

クラスの削除 delete

スキーマレジストリからクラスを削除する必要がある場合があります。これは、パスで指定されたクラス IDを使用してDELETE リクエストを実行することによって実行されます。

API 形式

DELETE /tenant/classes/{CLASS_ID}

パラメーター

説明

{CLASS_ID}

URL エンコードされた$id URIまたは削除するクラスのmeta:altId。

リクエスト

curl -X DELETE \
  https://platform.adobe.io/data/foundation/schemaregistry/tenant/classes/_{TENANT_ID}.classes.d5cc04eb8d50190001287e4c869ebe67 \
  -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 ステータス 204 （コンテンツなし）が返されます。

削除を確認するには、クラスの参照（GET）要求を試みます。リクエストにAccept ヘッダーを含める必要がありますが、クラスがスキーマレジストリから削除されたため、HTTP ステータス 404 （見つかりません）を受け取る必要があります。

recommendation-more-help

experience-platform-help-xdm