Schema Registry API ガイド

Schema Registry は、Adobe Experience Platform内のスキーマライブラリへのアクセスに使用され、使用可能なすべてのライブラリリソースにアクセスできるユーザーインターフェイスと RESTful API を提供します。

スキーマレジストリ API は、すべてのスキーマと、Platform 内で使用可能な関連する Experience Data Model(XDM) リソースをプログラムで管理できる複数のエンドポイントを提供します。 これには、Adobe、Experience Platform パートナー、および使用するアプリケーションのベンダーが定義したものが含まれます。

これらのエンドポイントの概要を以下に示します。詳しくは、個々のエンドポイントのガイドを参照し、必要なヘッダー、サンプル API 呼び出しの読み取りなどに関する重要な情報については、はじめにのガイドを参照してください。

重要

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

使用可能なすべてのエンドポイントと CRUD 操作を表示するには、 スキーマレジストリ API リファレンス を参照してください。

スキーマ

XDM スキーマは、Platform に取り込まれるデータの構造と形式を表し、検証します。 スキーマは、クラスと 0 個以上のスキーマフィールドグループで構成されます。 /schemas エンドポイントを使用して、スキーマの作成、表示、編集および削除をおこなうことができます。 このエンドポイントの使用方法については、『 スキーマエンドポイントガイド 』を参照してください。

フィールドグループやデータ型の作成と追加を含め、スキーマレジストリ API で完全なスキーマを作成する手順については、『API スキーマ作成のチュートリアル 』を参照してください。

動作

ビヘイビアーは、スキーマが記述するデータの特性を定義します。 各 XDM クラスは、特定の動作を参照する必要があります。この動作は、そのクラスを使用するすべてのスキーマが継承します。 API で使用可能な動作を表示する方法については、『 動作エンドポイントのガイド 』を参照してください。

クラス

クラスは、そのクラスに基づくすべてのスキーマに含める必要がある共通プロパティの基本構造を定義し、それらのスキーマで使用する資格のあるフィールドグループを決定します。 すべてのクラスは、既存の動作に関連付ける必要があります。 API でのクラスの操作について詳しくは、 クラスエンドポイントガイド を参照してください。

フィールドグループ

フィールドグループは、個人、郵送先住所、Web ブラウザー環境など、特定の概念を表す 1 つ以上のフィールドを定義する再利用可能なコンポーネントです。 フィールドグループは、互換性のあるクラスを実装するスキーマの一部として含めることを目的としています。このクラスは、表すデータ(レコードまたは時系列)の動作に応じて異なります。 API でフィールドグループを使用する方法については、 フィールドグループエンドポイントガイド を参照してください。

データタイプ

データ型は、基本リテラルフィールドと同じ方法で、クラスやフィールドグループの参照型フィールドとして使用されます。重要な違いは、データ型が複数のサブフィールドを定義できる点です。 複数フィールド構造を一貫して使用できるという点ではフィールドグループと同様ですが、データ型はスキーマ構造の任意の場所に含めることができるのに対し、フィールドグループはルートレベルでのみ追加できるので、より柔軟です。 API でのデータ型の操作について詳しくは、『 データ型エンドポイントガイド 』を参照してください。

記述子

記述子 は、スキーマ内の特定のフィールドに割り当てられるメタデータのセットで、これらのフィールド(およびスキーマ自体)が他のスキーマとどのように関連しているかなど、様々なコンテキストの詳細を提供します。 各スキーマには、1 つ以上の記述子エンティティを適用でき、異なる目的を果たすために、複数の異なる記述子型があります。 API での記述子の操作に関する詳細、および様々な記述子の種類とその使用例の概要については、 記述子のエンドポイントのガイド を参照してください。

和集合

Platform では特定の使用例のスキーマを作成できますが、特定のクラスに属するスキーマの「和集合」を作成することもできます。 和集合スキーマは、同じクラスを共有するすべてのスキーマのフィールドを 1 つの表現に集計します。 リアルタイム顧客プロファイル で使用するスキーマを有効にすると、そのスキーマは特定のクラスの和集合に含まれます。 したがって、和集合スキーマを直接編集することはできず、影響を受けるのは、プロファイルで使用するスキーマを含めるか除外することだけです。

スキーマレジストリ API で和集合を表示する方法については、 和集合エンドポイントガイド を参照してください。

書き出し/読み込み

スキーマレジストリ API を使用すると、サンドボックスと IMS 組織の間で XDM リソースを転送および共有できます。 任意のスキーマ、フィールドグループまたはデータタイプに対して、リソースの構造と依存するリソースを含む書き出しペイロードを生成できます。 このペイロードは、その後、リソースを宛先サンドボックスと IMS 組織に読み込むために使用できます。

これらのエンドポイントの使用方法の詳細については、『 書き出し/読み込みエンドポイントのガイド 』を参照してください。

サンプルデータ

スキーマライブラリ内の指定したスキーマのサンプルデータを生成できます。 返された応答オブジェクトは、データの取り込み元として使用できます。

このエンドポイントの使用について詳しくは、 サンプルデータエンドポイントガイド を参照してください。

監査ログ

スキーマレジストリは、異なる更新の間にリソース(クラス、フィールドグループ、データタイプ、スキーマ)に対して行われたすべての変更のログを保持します。 特定のリソースのログを取得するには、このエンドポイントへのGETリクエストのパスに $id または meta:altId を指定します。

このエンドポイントの使用について詳しくは、 監査ログエンドポイントのガイド を参照してください。

次の手順

API を使用して呼び出しを開始するには、はじめにを参照し、エンドポイントガイドの 1 つを選択して、特定のエンドポイントの使用方法を確認します。

このページ