スキーマレジストリ API を使用したスキーマへの特定のフィールドの追加

最終更新日： 2024年7月16日
  • トピック：

作成対象：

  • 開発者

Experience Data Model（XDM）スキーマは基本クラスで構成され、アドビで定義された標準フィールドグループと、組織で定義されたカスタムフィールドグループを使用して追加のフィールドを含めます。

スキーマを作成する際に、特定のフィールドグループの一部のフィールドを使用し、必要のない同じグループの他のフィールドを除外することができます。このチュートリアルでは、スキーマレジストリ API を使用して、フィールドグループからスキーマに個々のフィールドを追加する方法について説明します。

NOTE
Adobe Experience Platform UI で個々のスキーマフィールドを追加および削除する方法について詳しくは、フィールドベースのワークフロー（現在はベータ版）を参照してください。

前提条件

このチュートリアルでは、Schema Registry API を呼び出します。開始する前に、開発者ガイド で、{TENANT_ID}、コンテナの概念、リクエストを行うために必要なヘッダーなど、API に対する呼び出しを正常に行うために知っておく必要がある重要な情報を確認してください。

meta:refProperty フィールドについて

特定のスキーマについて、その構造を構成するクラスおよびフィールドグループは、その allOf 配列の下で参照します。各コンポーネントは、コンポーネントの URI $id を参照する $ref プロパティを含むオブジェクトとして表されます。

次の JSON は、単一のクラス（experienceevent）とフィールドグループ（experienceevent-all）を使用するシンプル化されたスキーマを表しています。

{
  "title": "My Sample Schema",
  "description": "My Sample Description",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all"
    }
  ]
}

フィールドグループを参照する allOf 配列内の任意のオブジェクトについて、兄弟の meta:refProperty フィールドを追加すると、スキーマに含めるグループ内のフィールドを指定できます。

NOTE
各フィールドは、それぞれのフィールドグループ内のフィールドへのパスを表す JSON ポインター文字列を使用して指定します。文字列の先頭は、スラッシュ（/）で始める必要があります。properties の名前空間を含めることはできません。例：/_experience/campaign/message/id。

文字列として含める場合、meta:refProperty はグループ内の単一のフィールドを参照できます。異なる meta:refProperty 値を持つ別のオブジェクトで同じ $ref 値を使用することにより、同じグループの他のフィールドを含めることができます。

{
  "title": "My Sample Schema",
  "description": "An example schema that uses the XDM ExperienceEvent class.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": "/_experience/campaign/message/id"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": "/_experience/campaign/message/size"
    }
  ]
}

または、meta:refProperty を配列として指定することもできます。これにより、単一の allOf リスト項目内の特定のグループから複数のフィールドを含めるように指定できます。

{
  "title": "My Sample Schema",
  "description": "An example schema that uses the XDM ExperienceEvent class.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/context/experienceevent"
    },
    {
      "$ref": "https://ns.adobe.com/experience/campaign/experienceevent-all",
      "meta:refProperty": [
        "/_experience/campaign/message/id",
        "/_experience/campaign/message/size",
        "/_experience/campaign/message/variant"
      ]
    }
  ]
}