Schema Registry API ガイド

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

Schema Registry API は、Platform 内で使用可能なすべてのスキーマと関連する Experience Data Model （XDM）リソースをプログラムで管理できるいくつかのエンドポイントを提供します。 これには、Adobe、Experience Platform パートナー、およびユーザーが使用するアプリケーションのベンダーが定義した要件が含まれます。

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

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

スキーマ

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

フィールドグループやデータタイプの作成と追加など、Schema Registry API で完全なスキーマを手動で作成する手順については、API スキーマ作成チュートリアルを参照してください。

CSV データを取り込む場合は、CSV からスキーマへの変換の節を参照してください。

動作

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

クラス

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

フィールドグループ

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

データタイプ

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

記述子

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

和集合

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

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

CSV からスキーマへの変換 csv-to-schema

CSV ファイルをテンプレートとして使用して XDM スキーマを自動的に生成できます。これにより、スキーマフィールドを一括読み込みするテンプレートを作成でき、手動の API や UI の作業を減らすことができます。

詳しくは、CSV からスキーマへの変換エンドポイントガイドを参照してください。

書き出し export

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

既存の XDM リソースの書き出しペイロードを作成する方法について詳しくは、 書き出しエンドポイントガイドを参照してください。

インポート

エクスポートまたは CSV をスキーマ変換エンドポイントを使用してエクスポートペイロードを作成する場合、そのペイロードをターゲット組織とサンドボックスに送信して、指定したリソースを読み込むことができます。

エクスポートペイロードから XDM リソースを生成する方法について詳しくは、 インポートエンドポイントガイドを参照してください。

サンプルデータ

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

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

監査ログ

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

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

次の手順

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