カスタムメタデータのサポート - XDM形式

Experience Edge APIを使用すると、sessionStartadStart、およびchapterStart API イベントの標準XDM フィールドと一緒にメディアカスタムメタデータを送信できます。 XDM フォーマットを介して送信されたメディアカスタムメタデータは、Adobe Analytics​と​ Adobe Experience Platform ​の両方に転送できます。

Media Collection API実装については、​ カスタムメタデータのサポート ​を参照してください。

概要

Adobe Experience Edgeリクエスト内の2つの場所に、それぞれ異なるルーティング動作でメディアカスタムメタデータを送信できます。

場所
Adobe Analyticsに送信
Adobe Experience Platformに送信
使用例
xdm.mediaCollection.customMetadata
✅はい
✅はい
両方のシステムで必要なビジネスデータ
_data
✅はい
❌いいえ
Analytics固有のフラグまたは処理ヒント

カスタムメタデータは、次の3つのイベントタイプに適用されます。

イベント
メタデータの適用先
sessionStart
メインコンテンツ(セッション全体)
adStart
個人広告
chapterStart
コンテンツの章またはセグメント

構造

xdm.mediaCollection.customMetadata (Analytics + AEP)

カスタムメタデータは、mediaCollection オブジェクト内の​ 名前値オブジェクトの配列 ​です。

{
  "xdm": {
    "mediaCollection": {
      "customMetadata": [
        {
          "name": "_tenant.fieldName",
          "value": "fieldValue"
        }
      ]
    }
  }
}

<InlineAlert variant=“warning” slots=“text” />

customMetadataは、xdm ルートレベルではなく、mediaCollection内の​ 配列 ​である必要があります。

正しくない:

{
  "xdm": {
    "eventType": "media.sessionStart",
    "customMetadata": [...]  // ❌ Wrong location
  }
}

正解:

{
  "xdm": {
    "eventType": "media.sessionStart",
    "mediaCollection": {
      "customMetadata": [...]  // ✅ Inside mediaCollection
    }
  }
}

_data (Analyticsのみ)

_data オブジェクトは、AEP データセットをバイパスして、Adobe Analyticsにのみデータを送信する特別なExperience Edge構造です。 カスタムメタデータは__adobe.analytics.contextDataの下に配置する必要があります。

名前値オブジェクト ​配列を使用するxdm.mediaCollection.customMetadataとは異なり、_data マッピングでは、contextDataの直下にフラット キー値オブジェクト​を使用します。

アプローチ
構造
宛先
xdm.mediaCollection.customMetadata
{"name": "...", "value": "..."} オブジェクトの配列
Analytics + AEP
_data.__adobe.analytics.contextData
フラット キー値オブジェクト {"key": "value"}
Analyticsのみ
{
  "xdm": { ... },
  "_data": {
    "__adobe": {
      "analytics": {
        "contextData": {
          "debugMode": "true",
          "internalTestFlag": "QA-Session"
        }
      }
    }
  }
}

命名規則

  • XDM形式:​接頭辞と、アンダースコアを使用したテナント名前空間。 テナントカスタムフィールドグループ(_<tenant>.<struct_name>.<field_name>など)に構造を作成することもできます。
  • _data形式: フィールドは_data.__adobe.analytics.contextDataの下に配置されます。フィールド名にアンダースコアのプレフィックスは必要ありません(例:debugFlag

メインコンテンツのカスタムメタデータ

sessionStart様と共に送信されました。 追跡中のプライマリメディアに適用され、広告およびチャプターの呼び出し全体を通じて引き続き利用できます。 ここで定義されたカスタムメタデータは、対応するクローズ呼び出しのメディアバックエンドによって自動的にマージされます。 広告やチャプターに定義された特定のカスタムメタデータと一緒に含まれます。

リクエスト

curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
          "sessionDetails": {
            "name": "Sample Video",
            "playerName": "HTML5 Player",
            "contentType": "VOD",
            "length": 3600,
            "channel": "Sports"
          },
          "playhead": 0,
          "customMetadata": [
            {
              "name": "_mycompany.contentCategory",
              "value": "Live Sports"
            },
            {
              "name": "_mycompany.leagueType",
              "value": "Professional"
            }
          ]
        },
        "timestamp": "2026-03-10T18:00:00Z"
      }
    }
  ]
}'

カスタムメタデータの追加

adStart様と共に送信されました。 個別の広告に固有のものです。 sessionStartのカスタムメタデータも、ここで定義されている広告固有のカスタムメタデータとともに、広告終了呼び出しのメディアバックエンドによって自動的に結合されます。

リクエスト

curl -X POST "https://edge.adobedc.net/ee/va/v1/adStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.adStart",
        "mediaCollection": {
          "sessionID": "your-session-id",
          "playhead": 30,
          "advertisingDetails": {
            "name": "Summer Sale Ad",
            "playerName": "HTML5 Player",
            "length": 30,
            "podPosition": 1
          },
          "customMetadata": [
            {
              "name": "_mycompany.campaignId",
              "value": "SUMMER2026"
            },
            {
              "name": "_mycompany.targetAudience",
              "value": "18-34"
            },
            {
              "name": "_mycompany.adFormat",
              "value": "skippable"
            }
          ]
        },
        "timestamp": "2026-03-10T18:05:30Z"
      }
    }
  ]
}'

章カスタムメタデータ

chapterStart様と共に送信されました。 コンテンツの章やセグメントごとに固有です。 sessionStartのカスタムメタデータも、ここで定義されている章固有のカスタムメタデータとともに、章クローズ呼び出しのメディアバックエンドによって自動的に結合されます。

リクエスト

curl -X POST "https://edge.adobedc.net/ee/va/v1/chapterStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.chapterStart",
        "mediaCollection": {
          "sessionID": "your-session-id",
          "playhead": 600,
          "chapterDetails": {
            "friendlyName": "Introduction",
            "length": 300,
            "index": 1,
            "offset": 600
          },
          "customMetadata": [
            {
              "name": "_mycompany.chapterType",
              "value": "tutorial"
            },
            {
              "name": "_mycompany.difficulty",
              "value": "beginner"
            }
          ]
        },
        "timestamp": "2026-03-10T18:10:00Z"
      }
    }
  ]
}'

_data オブジェクトの使用(Analytics専用メタデータ)

_data オブジェクトは、AEP データセットに​ not ​を保存する必要があるAdobe Analyticsのメタデータ(一時フラグ、デバッグ変数、Analytics固有の処理ヒントなど)が必要な場合に使用します。

<InlineAlert variant=“warning” slots=“text” />

_dataを介して送信されたデータはAdobe Experience Platformに保存されないため、Real-Time CDP、Journey Orchestration、またはその他のAEP サービスでは使用できません。

リクエスト

curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
          "sessionDetails": {
            "name": "Sample Video",
            "playerName": "HTML5 Player",
            "contentType": "VOD",
            "length": 3600
          },
          "playhead": 0,
          "customMetadata": [
            {
              "name": "_mycompany.league",
              "value": "Action"
            }
          ]
        },
        "timestamp": "2026-03-10T18:00:00Z"
      },
      "_data": {
        "__adobe": {
          "analytics": {
            "contextData": {
              "debugMode": "true",
              "testFlag": "QA-Session"
            }
          }
        }
      }
    }
  ]
}'

この例では、次のようになります。

下流のデータの場所

<InlineAlert variant=“info” slots=“text” />

xdm.mediaCollection.customMetadataは、イベントを含むカスタムメタデータの送信に使用される​ 受信API パス ​です。 処理後、データはコンテキストデータ変数としてAdobe Analyticsに転送され、mediaReporting.customMetadataの下のAdobe Experience Platformと最上位の統合フィールドとして保存されます。

Adobe Analytics:

Adobe Experience Platform:

動作

関連ドキュメント

recommendation-more-help
media-analytics-help