Schema Registry API ガイド

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

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

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

利用可能なすべてのエンドポイントとCRUD操作を表示するには、Schema Registry API リファレンス ​にアクセスしてください。

スキーマ

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

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

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

動作

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

クラス

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

フィールドグループ

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

データタイプ

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

記述子

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

和集合

Experience Platformでは、特定のユースケースのスキーマを作成できますが、特定のクラスに属するスキーマの「結合」を作成することもできます。 結合スキーマは、同じクラスを共有するすべてのスキーマのフィールドを単一の表現に集約します。 Real-Time Customer Profileで使用するスキーマを有効にすると、そのスキーマは特定のクラスの結合に含まれます。 そのため、結合スキーマは直接編集できず、プロファイルで使用するスキーマを含めるか除外することによってのみ影響を受けます。

Schema Registry APIで結合を表示する方法については、unions エンドポイントガイド ​を参照してください。

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

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

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

書き出し export

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

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

インポート

exportまたはCSV to schema conversion エンドポイントを使用してエクスポートペイロードを作成する場合、そのペイロードをターゲット組織およびサンドボックスに送信して、指定したリソースをインポートできます。

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

サンプルデータ

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

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

監査ログ

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

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

次の手順

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