CSV テンプレートからスキーマ変換 API エンドポイントへ
Schema Registry API の /rpc/csv2schema
エンドポイントを使用すると、CSV ファイルをテンプレートとして使用して、エクスペリエンスデータモデル(XDM)スキーマを自動的に作成できます。 このエンドポイントを使用すると、テンプレートを作成してスキーマフィールドを一括読み込みし、手動の API や UI の作業を減らすことができます。
はじめに
/rpc/csv2schema
エンドポイントは、Schema Registry API の一部です。 先に進む前に、 はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意のAdobe Experience Platform API を正常に呼び出すために必要なヘッダーに関する重要な情報を確認してください。
/rpc/csv2schema
エンドポイントは、Schema Registry でサポートされているリモート プロシージャ コール (RPC)の一部です。 Schema Registry API の他のエンドポイントとは異なり、RPC エンドポイントには Accept
や Content-Type
などの追加のヘッダーは必要なく、CONTAINER_ID
も使用しません。 代わりに、以下の API 呼び出しで示すように、/rpc
名前空間を使用する必要があります。
CSV ファイルの要件
このエンドポイントを利用するには、まず適切な列ヘッダーと対応する値を持つ CSV ファイルを作成する必要があります。 一部の列は必須ですが、残りはオプションです。 次の表に、これらの列と、スキーマ構築での列の役割を示します。
isIgnored
true
に設定した場合、は、フィールドが API アップロードの準備ができていないので無視する必要があることを示します。isCustom
fieldGroupId
fieldGroupName
カスタムフィールドで既存の標準フィールドが拡張されない場合はオプション。 空白のままにすると、名前が自動的に割り当てられます。
標準フィールドまたは標準フィールドグループを拡張するカスタムフィールドで必須。
fieldGroupId
のクエリに使用されます。fieldPath
fieldGroupName
に示されている)を含めるには、値を ALL
に設定します。displayName
fieldDescription
dataType
dataType
が object
に設定されている場合、properties
または $ref
のいずれかを同じ行に対しても定義する必要がありますが、両方に定義する必要はありません。isRequired
isArray
dataType
の配列であるかどうかを示します。isIdentity
isPrimaryIdentity
minimum
maximum
enum
[value1,value2,value3]
)。stringPattern
format
minLength
maxLength
properties
dataType
が object
に設定され、$ref
が定義されていない場合は必須です。 これは、オブジェクトの本文を JSON 文字列(例:{"myField": {"type": "string"}}
)として定義します。$ref
dataType
が object
に設定され、properties
が定義されていない場合は必須です。 これは、オブジェクトタイプ(例:https://ns.adobe.com/xdm/context/person
)の参照オブジェクトの $id
を定義します。comment
isIgnored
を true
に設定すると、この列を使用してスキーマのヘッダー情報を提供します。CSV ファイルの形式を決定するには、次の CSV テンプレートを参照してください。
CSV ファイルからの書き出しペイロードの作成
CSV テンプレートを設定したら、ファイルを /rpc/csv2schema
エンドポイントに送信し、書き出しペイロードに変換できます。
API 形式
POST /rpc/csv2schema
リクエスト
リクエストペイロードでは、フォームデータを形式として使用する必要があります。 必須のフォームフィールドを以下に示します。
curl -X POST \
https://platform.adobe.io/data/foundation/schemaregistry/rpc/csv2schema \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-F 'csv-file=@"/Users/userName/Documents/sample-csv-template.csv"' \
-F 'schema-class-id="https://ns.adobe.com/xdm/context/profile"' \
-F 'schema-name="Example Schema"' \
-F 'schema-description="Example schema description."'
csv-file
schema-class-id
$id
。schema-name
schema-description
応答
応答が成功すると、CSV ファイルから生成された書き出しペイロードが返されます。 ペイロードは配列形式を取り、各配列項目はスキーマの依存 XDM コンポーネントを表すオブジェクトです。 以下の節を選択して、CSV ファイルから生成された書き出しペイロードの完全な例を表示します。
code language-json |
---|
|
スキーマペイロードの読み込み
CSV ファイルから書き出しペイロードを生成したら、そのペイロードを /rpc/import
エンドポイントに送信して、スキーマを生成できます。
エクスポートペイロードからスキーマを生成する方法について詳しくは、 インポートエンドポイントガイドを参照してください。