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

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

書き出し/読み込み

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

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

サンプルデータ

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

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

監査ログ

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

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

次の手順

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

このページ