Schema Registry API での XDM フィールドの定義

最終更新日： 2025年5月14日
  • トピック：

作成対象：

  • 開発者

すべてのエクスペリエンスデータモデル（XDM）フィールドは、フィールドタイプに適用される標準 JSON スキーマ制約を使用して定義され、Adobe Experience Platformによって適用されるフィールド名の制約も追加されます。 Schema Registry API では、形式とオプションの制約を使用して、スキーマにカスタムフィールドを定義できます。 XDM フィールドタイプは、フィールドレベルの属性 meta:xdmType で公開されます。

メモ
meta:xdmType はシステムで生成される値なので、API を使用する場合（ カスタムマップタイプの作成を除く）、このプロパティをフィールドの JSON に追加する必要はありません。 ベストプラクティスは、次の表で定義されている適切な min/max 制約を使用して JSON スキーマタイプ（string や integer など）を使用することです。

このガイドでは、オプションのプロパティを含む、様々なフィールドタイプを定義するための適切な形式について説明します。 オプションのプロパティとタイプ固有のキーワードに関する詳細については、JSON スキーマのドキュメントを参照してください。

まず、目的のフィールドタイプを見つけ、提供されたサンプルコードを使用して フィールドグループの作成または データタイプの作成のための API リクエストを作成します。

文字列

​ 文字列 ​ フィールドは type: string で示されます。

"sampleField": {
  "title": "Sample String Field",
  "description": "An example string field.",
  "type": "string"
}

オプションで、次の追加のプロパティを使用して、文字列に入力できる値の種類を制限できます。

  • pattern：制約の基準となる正規表現パターン。
  • minLength：文字列の最小の長さ。 文字列は、デフォルトで最小値 1 を受け取ります。
  • maxLength：文字列の最大長。
"sampleField": {
  "title": "Sample String Field",
  "description": "An example string field with added constraints.",
  "type": "string",
  "pattern": "^[A-Z]{2}$",
  "maxLength": 2
}

URI

URI フィールドは、format プロパティが uri に設定された type: string で示されます。 その他のプロパティは使用できません。

"sampleField": {
  "title": "Sample URI Field",
  "description": "An example URI field.",
  "type": "string",
  "format": "uri"
}