スキーマレジストリ API ガイドの付録

このドキュメントでは、Schema Registry API の操作に関する補足情報を提供します。

クエリパラメーターの使用 query

Schema Registry では、リソースをリスト表示する際に、クエリパラメーターを使用して結果をページ化およびフィルタリングする機能をサポートしています。

ページング paging

ページングに最も一般的なクエリパラメーターは次のとおりです。

フィルタリング filtering

property パラメーターを使用して結果をフィルタリングできます。このパラメーターは、取得したリソース内の特定の JSON プロパティに対して特定の演算子を適用するために使用されます。 次の演算子がサポートされています。

互換性モード compatibility

Experience Data Model （XDM）はパブリックに文書化された仕様であり、デジタルエクスペリエンスの相互運用性、表現力、パワーを向上させるためのAdobeによって推進されています。 アドビは、GitHub のオープンソースプロジェクトでソースコードと公式の XDM 定義を公開しています。これらの定義は XDM 標準表記で記述され、JSON-LD （JavaScript Object Notation for Linked Data）および JSON スキーマを XDM スキーマを定義する文法として使用しています。

パブリックリポジトリーで公式の XDM 定義を見ると、標準 XDM は Adobe Experience Platform での表示とは異なることがわかります。Experience Platform に表示されるものは互換性モードと呼ばれ、標準 XDM と Platform 内での使用方法との間の簡単なマッピングを提供します。

互換性モードの仕組み

互換性モードを使用すると、XDM JSON-LD モデルは、同じセマンティクスを保持したままで標準 XDM 内の値を変更することにより、既存のデータインフラストラクチャと連携できます。ネストされた JSON 構造を使用して、スキーマをツリーに類似した形式で表示します。

標準 XDM と互換性モードの主な違いは、フィールド名の「xdm:」プレフィックスが削除されていることです。

標準 XDM と互換性モードの誕生日関連のフィールド（"description" 属性が削除された）を並べて比較したものを次に示します。互換性モードのフィールドでは、"meta:xdmField" 属性と "meta:xdmType" 属性に XDM フィールドへの参照とそのデータ型が含まれていることに注意してください。

{
  "xdm:birthDate": {
    "title": "生年月日",
    "type": "string",
    "format": "date"
  }、
  "xdm:birthDayAndMonth": {
    "title": "生年月日",
    "type": "string",
    "pattern": "[0-1][0-9]-[0-9][0-9]"
  }、
  "xdm:birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum":1,
    "maximum": 32767
  }
}

{
  "birthDate": {
    "title": "生年月日",
    "type": "string",
    "format": "date",
    "meta:xdmField": "xdm:birthDate",
    "meta:xdmType": "date"
  }、
  "birthDayAndMonth": {
    "title": "生年月日",
    "type": "string",
    "pattern": "[0-1][0-9]-[0-9][0-9]",
    "meta:xdmField": "xdm:birthDayAndMonth",
    "meta:xdmType": "string"
  }、
  "birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum":1,
    「maximum」:32767、
    "meta:xdmField": "xdm:birthYear",
    "meta:xdmType": "short"
  }
}

互換性モードが必要な理由

Adobe Experience Platform は、複数のソリューションやサービスと連携するように設計されており、各ソリューションおよびサービスには固有の技術的課題と制限（特定のテクノロジーが特殊文字を処理する方法など）があります。これらの制限を克服するために、互換モードが開発されました。

Catalog、Data Lake、Real-Time Customer Profile など、ほとんどの Experience Platform サービスは、標準の XDM の代わりに Compatibility Mode を使用します。 Schema Registry API でも Compatibility Mode を使用しています。このドキュメントの例はすべて、Compatibility Mode を使用して示しています。

標準 XDM と Experience Platform での運用化の方法の間でマッピングが行われることを知っておくことは価値がありますが、Platform サービスの使用には影響しません。

オープンソースプロジェクトは利用可能ですが、Schema Registry を通じてリソースを操作する場合、このドキュメントの API の例では、知っていて従う必要があるベストプラクティスを提供しています。