Schema Registry API の概要

Schema Registry API を使用すると、様々なエクスペリエンスデータモデル (XDM) リソースを作成および管理できます。 このドキュメントでは、Schema Registry API を呼び出す前に知っておく必要があるコア概念の概要を説明します。

前提条件

開発者ガイドを使用するには、Adobe Experience Platformの次のコンポーネントに関する十分な知識が必要です。

  • Experience Data Model (XDM) System:顧客体験データを編成する際に Experience Platform に使用される標準化されたフレームワーク。
  • Real-time Customer Profile:複数のソースからの集計データに基づいて、統合されたリアルタイムの顧客プロファイルを提供します。
  • Sandboxes: Experience Platform は、単一のインスタンスを別々の仮想環境に分 Platform 割して、デジタルエクスペリエンスアプリケーションの開発と発展を支援する仮想サンドボックスを提供します。

XDM では、JSON スキーマの形式を使用して、取り込んだ顧客体験データの構造を記述し、検証します。 したがって、この基盤となるテクノロジーの理解を深めるために、 公式の JSON スキーマのドキュメント を確認することを強くお勧めします。

API 呼び出し例の読み取り

Schema Registry API ドキュメントには、API 呼び出しの例とリクエストの形式を指定する方法が示されています。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、Experience Platform トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。

必須ヘッダーの値の収集

Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Schema Registry に属するリソースを含む Experience Platform 内のすべてのリソースは、特定の仮想サンドボックスに分離されます。 Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

  • x-sandbox-name: {SANDBOX_NAME}
メモ

Platform のサンドボックスについて詳しくは、 サンドボックスのドキュメント を参照してください。

Schema Registry に対するすべての検索 (GET) リクエストには、追加の Accept ヘッダーが必要です。このヘッダーの値によって、API から返される情報の形式が決まります。 詳しくは、この後の Accept ヘッダーの節を参照してください。

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

使用する TENANT_ID

API ガイド全体を通して、TENANT_ID への参照が表示されます。 この ID は、作成したリソースに名前空間が適切に設定されていること、またそのリソースが IMS 組織内に格納されていることを確認するために使用されます。ID が不明な場合は、次の GET リクエストを実行して ID にアクセスします。

API 形式

GET /stats

リクエスト

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/stats \
  -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}'

応答

正常な応答は、組織の Schema Registry の使用に関する情報を返します。 この中には TENANT_ID の値である tenantId 属性が含まれています。

{
  "imsOrg":"{IMS_ORG}",
  "tenantId":"{TENANT_ID}",
  "counts": {
    "schemas": 4,
    "mixins": 3,
    "datatypes": 1,
    "classes": 2,
    "unions": 0,
  },
  "recentlyCreatedResources": [ 
    {
      "title": "Sample Field Group",
      "description": "New Sample Field Group.",
      "meta:resourceType": "mixins",
      "meta:created": "Sat Feb 02 2019 00:24:30 GMT+0000 (UTC)",
      "version": "1.1"
    },
    {
      "$id": "https://ns.adobe.com/{TENANT_ID}/classes/5bdb5582be0c0f3ebfc1c603b705764f",
      "title": "Tenant Class",
      "description": "Tenant Defined Class",
      "meta:resourceType": "classes",
      "meta:created": "Fri Feb 01 2019 22:46:21 GMT+0000 (UTC)",
      "version": "1.0"
    } 
  ],
  "recentlyUpdatedResources": [
    {
      "title": "Sample Field Group",
      "description": "New Sample Field Group.",
      "meta:resourceType": "mixins",
      "meta:updated": "Sat Feb 02 2019 00:34:06 GMT+0000 (UTC)",
      "version": "1.1"
    },
    {
      "title": "Data Schema",
      "description": "Schema for Data Information",
      "meta:resourceType": "schemas",
      "meta:updated": "Fri Feb 01 2019 23:47:43 GMT+0000 (UTC)",
      "meta:class": "https://ns.adobe.com/{TENANT_ID}/classes/47b2189fc135e03c844b4f25139d10ab",
      "meta:classTitle": "Sample Class",
      "version": "1.1"
    }
 ],
 "classUsage": {
    "https://ns.adobe.com/{TENANT_ID}/classes/47b2189fc135e03c844b4f25139d10ab": [
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/274f17bc5807ff307a046bab1489fb18",
        "title": "Tenant Data Schema",
        "description": "Schema for tenant-specific data."
      }
    ],
    "https://ns.adobe.com/xdm/context/profile": [
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/3ac6499f0a43618bba6b138226ae3542",
        "title": "Simple Profile",
        "description": "A simple profile schema."
      },
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/fbc52b243d04b5d4f41eaa72a8ba58be",
        "title": "Program Schema",
        "description": "Schema for program-related data."
      },
      {
        "$id": "https://ns.adobe.com/{TENANT_ID}/schemas/4025a705890c6d4a4a06b16f8cf6f4ca",
        "title": "Sample Schema",
        "description": "A sample schema."
      }
    ]
  }
 }

CONTAINER_ID について

Schema Registry API の呼び出しでは、CONTAINER_ID を使用する必要があります。 API 呼び出しを実行できるコンテナは 2 つあります。global コンテナと tenant コンテナ

グローバルコンテナ

global コンテナには、すべての標準Adobeと Experience Platform パートナーが指定したクラス、スキーマフィールドグループ、データ型、スキーマが格納されます。 global コンテナに対してのみ、リストリクエストと検索 (GET) リクエストを実行できます。

global コンテナを使用する呼び出しの例を次に示します。

GET /global/classes

テナントコンテナ

固有の TENANT_ID と混同しないでください。tenant コンテナには、IMS 組織が定義したすべてのクラス、フィールドグループ、データ型、スキーマ、および記述子が格納されます。 これらは各組織に固有のもので、他の IMS 組織では表示も管理もできません。tenant コンテナで作成したリソースに対して、すべての CRUD 操作 (GET、POST、PUT、PATCH、DELETE) を実行できます。

tenant コンテナを使用する呼び出しの例を次に示します。

POST /tenant/fieldgroups

tenant コンテナ内に作成したクラス、フィールドグループ、スキーマ、データ型は Schema Registry に保存され、TENANT_ID を含む $id URI が割り当てられます。 この $id は、API 全体で特定のリソースを参照する際に使用されます。$id 値の例については、次の節で説明します。

リソースの識別

XDM リソースは、次の例のように、URI 形式の $id 属性で識別されます。

  • https://ns.adobe.com/xdm/context/profile
  • https://ns.adobe.com/{TENANT_ID}/schemas/7442343-abs2343-21232421

URI をより REST に適したものにするために、スキーマでは、meta:altId と呼ばれるプロパティで、ドット表記でエンコードされた URI を使用できます。

  • _xdm.context.profile
  • _{TENANT_ID}.schemas.7442343-abs2343-21232421

Schema Registry API の呼び出しでは、URL エンコードされた $id URI または meta:altId(ドット表記形式)がサポートされます。 API への REST 呼び出しを実行する際には、URL エンコードされた $id URI を使用することをお勧めします。

  • https%3A%2F%2Fns.adobe.com%2Fxdm%2Fcontext%2Fprofile
  • https%3A%2F%2Fns.adobe.com%2F{TENANT_ID}%2Fschemas%2F7442343-abs2343-21232421

Accept ヘッダー

Schema Registry API でリストおよび検索 (GET) 操作を実行する場合、API から返されるデータの形式を判断するには、Accept ヘッダーが必要です。 特定のリソースを検索する場合は、Accept ヘッダーにバージョン番号も含める必要があります。

次の表に、互換性のある Accept ヘッダー値(バージョン番号を持つヘッダー値を含む)と、API を使用した場合に返される内容の説明を示します。

Accept 説明
application/vnd.adobe.xed-id+json ID のリストのみを返します。これは、リソースを一覧表示する際に最も使用される値です。
application/vnd.adobe.xed+json 元の $ref および allOf を含むフル JSON スキーマのリストを返します。これは、全リソースのリストを返す際に使用されます。
application/vnd.adobe.xed+json; version=1 $refallOf を含む未処理の XDM です。タイトルと説明があります。
application/vnd.adobe.xed-full+json; version=1 $ref 属性と解決された allOf。タイトルと説明があります。
application/vnd.adobe.xed-notext+json; version=1 $refallOf を含む未処理の XDM です。タイトルや説明はありません。
application/vnd.adobe.xed-full-notext+json; version=1 $ref 属性と解決された allOf。タイトルや説明はありません。
application/vnd.adobe.xed-full-desc+json; version=1 $ref 属性と解決された allOf。記述子が含まれます。
メモ

現在、Platform は、各スキーマ (1) に対して 1 つのメジャーバージョンのみをサポートしています。 したがって、スキーマの最新のマイナーバージョンを返すには、ルックアップリクエストを実行する際、 version の値が常に 1 である必要があります。 スキーマのバージョン管理について詳しくは、以下のサブセクションを参照してください。

スキーマのバージョン管理

スキーマのバージョンは、スキーマレジストリ API の Accept ヘッダーと、ダウンストリーム Platform サービス API ペイロードの schemaRef.contentType プロパティで参照されます。

現在、Platform は各スキーマに対して 1 つのメジャーバージョン (1) のみをサポートしています。 スキーマ進化のルール に従い、スキーマを更新するたびに非破壊的にする必要があります。つまり、スキーマの新しいマイナーバージョン(1.21.3 など)は は、常に以前のマイナーバージョンとの後方互換性を保ちます。 したがって、version=1 を指定すると、スキーマレジストリは常にスキーマの 最新の メジャーバージョン 1 を返します。つまり、以前のマイナーバージョンは返されません。

メモ

スキーマの進化に対する非破壊的な要件は、スキーマがデータセットで参照され、次のいずれかの場合に該当する場合にのみ適用されます。

  • データはデータセットに取り込まれました。
  • データセットは、(データが取り込まれていない場合でも)リアルタイム顧客プロファイルでの使用が有効になっています。

上記の条件のいずれかを満たすデータセットにスキーマが関連付けられていない場合は、スキーマに対して変更を加えることができます。 ただし、どの場合でも version コンポーネントは 1 に残ります。

XDM フィールドの制約とベストプラクティス

スキーマのフィールドは、その properties オブジェクト内にリストされます。各フィールド自体はオブジェクトで、フィールドに格納できるデータを記述および制約する属性を含みます。

API でのフィールドの種類の定義について詳しくは、このガイドの フィールドの制約に関するガイド を参照してください。このガイドには、最も一般的に使用されるデータ型のコードサンプルとオプションの制約が記載されています。

以下のサンプルフィールドは、適切に形式が設定された XDM フィールドを表しています。サンプルコードの下に、命名時の制約とベストプラクティスが示されています。これらのベストプラクティスは、同様の属性を含むその他のリソースを定義する際にも適用できます。

"fieldName": {
    "title": "Field Name",
    "type": "string",
    "format": "date-time",
    "examples": [
        "2004-10-23T12:00:00-06:00"
    ],
    "description": "Full sentence describing the field, using proper grammar and punctuation.",
}
  • フィールドオブジェクトの名前には、英数字、ダッシュ、アンダースコアの各文字を使用できますが、先頭にアンダースコアを配置することは​できません
    • 正しい:fieldNamefield_name2Field-Namefield-name_3
    • 誤り:_fieldName
  • フィールドオブジェクトの名前には、キャメルケースを使用することをお勧めします。例:fieldName
  • フィールドには title が必要です。これは、単語の先頭のみ大文字で記述します。例:Field Name
  • フィールドには type が必要です。
    • 特定のタイプを定義する場合、オプションの format が必要なことがあります。
    • データに特定の形式を設定する必要がある場合は、examples を配列として追加できます。
    • フィールドの種類は、レジストリで任意のデータタイプを使用して定義することもできます。詳しくは、『データ型エンドポイントガイド』の データ型 の作成に関する節を参照してください。
  • description では、フィールドとフィールドデータについての関連情報を表します。スキーマにアクセスした人が誰でもフィールドの意図を理解できるように、明確な言葉で記述する必要があります。

API で異なるフィールドタイプを定義する方法の詳細については、 フィールドの制約 に関するドキュメントを参照してください。

次の手順

Schema Registry API を使用した呼び出しを開始するには、使用可能なエンドポイントガイドの 1 つを選択します。

このページ