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 endpoint. このエンドポイントの使用方法については、 スキーマエンドポイントガイド.

フィールドグループやデータ型の作成や追加を含め、スキーマレジストリ API で完全なスキーマを作成する方法に関する詳しい手順については、 API スキーマ作成のチュートリアル.

動作

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

クラス

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

フィールドグループ

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

データタイプ

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

記述子

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

和集合

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

スキーマレジストリ API で和集合を表示する方法については、 unions endpoint guide.

CSV からスキーマへの変換

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

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

エクスポート

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

詳しくは、 書き出しエンドポイントガイド を参照してください。

インポート

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

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

サンプルデータ

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

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

監査ログ

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

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

次の手順

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

このページ