すべてのエクスペリエンスデータモデル (XDM) スキーマは、クラスに基づいている必要があります。 クラスは、そのクラスに基づくすべてのスキーマに含める必要がある共通プロパティのベース構造と、それらのスキーマで使用する資格のあるスキーマフィールドグループを決定します。 さらに、スキーマのクラスは、スキーマに含まれるデータの動作の側面を決定します。そのうち、次の 2 つのタイプがあります。
スキーマ構成に対するデータ動作に関するクラスについて詳しくは、 スキーマ構成の基本.
この /classes
エンドポイント Schema Registry API を使用すると、エクスペリエンスアプリケーション内のクラスをプログラムで管理できます。
このガイドで使用するエンドポイントは、Schema Registry API の一部です。先に進む前に、はじめる前にを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。
すべてのクラスを global
または tenant
コンテナを作成するには、次に対してGETリクエストを実行します。 /global/classes
または /tenant/classes
、それぞれ。
リソースをリストする場合、スキーマレジストリでは結果セットを 300 項目に制限します。 この制限を超えるリソースを返すには、ページングパラメーターを使用する必要があります。 また、追加のクエリパラメーターを使用して結果をフィルタリングし、返されるリソースの数を減らすことをお勧めします。 詳しくは、 クエリパラメーター 詳しくは、付録のドキュメントを参照してください。
API 形式
GET /{CONTAINER_ID}/classes?{QUERY_PARAMS}
パラメーター | 説明 |
---|---|
{CONTAINER_ID} |
クラスの取得元のコンテナ: global (Adobe作成クラスの場合 ) または tenant 組織が所有するクラスの場合。 |
{QUERY_PARAMS} |
結果をフィルターするオプションのクエリパラメーター。詳しくは、 付録文書 を参照してください。 |
リクエスト
次のリクエストは、 tenant
コンテナ、使用 orderby
クエリパラメーターを使用してクラスを並べ替えます。 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 |
各リソースの完全な JSON クラスを元のと共に返します $ref および allOf 含まれる ( 制限: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"
}
}
}
クラスの ID をGETリクエストのパスに含めることで、特定のクラスを検索できます。
API 形式
GET /{CONTAINER_ID}/classes/{CLASS_ID}
パラメーター | 説明 |
---|---|
{CONTAINER_ID} |
取得するクラスを格納するコンテナ。 global (Adobe作成クラスまたは 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}"
}
カスタムクラスは、 tenant
コンテナを含める必要があります。POSTリクエストを実行します。
定義したカスタムクラスに基づいてスキーマを作成する場合、標準のフィールドグループは使用できません。 各フィールドグループは、各フィールドグループで互換性のあるクラスを定義します meta:intendedToExtend
属性。 新しいクラスと互換性のあるフィールドグループの定義を開始したら、 $id
の meta:intendedToExtend
フィールドグループの」) を参照している場合は、定義したクラスを実装するスキーマを定義するたびに、これらのフィールドグループを再利用できます。 詳しくは、 フィールドグループの作成 および スキーマの作成 (それぞれのエンドポイントガイド)を参照してください。
リアルタイム顧客プロファイルでカスタムクラスに基づくスキーマを使用する場合、和集合スキーマは同じクラスを共有するスキーマに基づいてのみ構築されることに注意する必要があります。 のような別のクラスの和集合にカスタムクラスのスキーマを含める場合 XDM 個人プロファイル または 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}"
}
}
へのGETリクエストの実行 すべてのクラスをリスト 内 tenant
コンテナに Property クラスが含まれるようになりました。 また、 ルックアップ (GET) リクエストの実行 URL エンコードされたを使用 $id
をクリックして、新しいクラスを直接表示します。
クラス全体を置き換えるには、PUT操作を使用します。つまり、リソースを書き直す必要があります。 PUTリクエストを通じてクラスを更新する場合、本文には、 新しいクラスの作成 POST。
クラス全体を置き換えるのではなく、クラスの一部のみを更新する場合は、 クラスの一部の更新.
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リクエストを使用します。 この Schema Registry は、以下を含むすべての標準的な JSON パッチ操作をサポートしています。 add
, remove
、および replace
. JSON パッチの詳細については、 API の基本事項ガイド.
個々のフィールドを更新する代わりに、リソース全体を新しい値に置き換える場合は、 置き換え操作を使用したPUTの置き換え.
API 形式
PATCH /tenant/class/{CLASS_ID}
パラメーター | 説明 |
---|---|
{CLASS_ID} |
URL エンコードされた $id URI or 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
は、 title
の propertyId
フィールドに入力します。
{
"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}"
}
}
場合によっては、クラスをスキーマレジストリから削除する必要があります。 これは、パスで指定されたクラス ID を使用してDELETEリクエストを実行することでおこなわれます。
API 形式
DELETE /tenant/classes/{CLASS_ID}
パラメーター | 説明 |
---|---|
{CLASS_ID} |
URL エンコードされた $id URI or 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(Not Found) を受け取る必要があります。