Schema Registry API ガイド付録

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

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

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

ページング paging

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

フィルタリング filtering

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

互換性モード 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とExperience Platform内での使用方法の間の簡単なマッピングを提供します。

互換性モードの仕組み

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

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

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

{
  "xdm:birthDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date"
  },
  "xdm:birthDayAndMonth": {
    "title": "Birth Date",
    "type": "string",
    「パターン」: "[0-1][0-9]-[0-9][0-9]"
  },
  "xdm:birthYear": {
    "title": "Birth year",
    "type": "integer",
    "minimum": 1,
    "maximum": 32767
  }
}

{
  "birthDate": {
    "title": "Birth Date",
    "type": "string",
    "format": "date",
    "meta:xdmField": "xdm:birthDate",
    "meta:xdmType": "date"
  },
  "birthDayAndMonth": {
    "title": "Birth Date",
    "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での運用方法との間でマッピングが行われることを知っておくことは価値がありますが、Experience Platform サービスの使用には影響しません。

オープンソースプロジェクトは利用できますが、Schema Registryを通じてリソースを操作する場合は、このドキュメントのAPIの例で、知っておくべきことと従うべきベストプラクティスが示されています。