カスタムメタデータのサポート - XDM形式
Experience Edge APIを使用すると、sessionStart、adStart、およびchapterStart API イベントの標準XDM フィールドと一緒にメディアカスタムメタデータを送信できます。 XDM フォーマットを介して送信されたメディアカスタムメタデータは、Adobe Analyticsと Adobe Experience Platform の両方に転送できます。
Media Collection API実装については、 カスタムメタデータのサポート を参照してください。
概要
Adobe Experience Edgeリクエスト内の2つの場所に、それぞれ異なるルーティング動作でメディアカスタムメタデータを送信できます。
xdm.mediaCollection.customMetadata_dataカスタムメタデータは、次の3つのイベントタイプに適用されます。
sessionStartadStartchapterStart構造
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": "..."} オブジェクトの配列_data.__adobe.analytics.contextData{"key": "value"}{
"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"
}
}
}
}
}
]
}'
この例では、次のようになります。
_mycompany.league→AnalyticsとAEPの両方に送信されましたdebugModeとtestFlag(_data.__adobe.analytics.contextData未満)→Analyticsにのみ送信されます
下流のデータの場所
<InlineAlert variant=“info” slots=“text” />
xdm.mediaCollection.customMetadataは、イベントを含むカスタムメタデータの送信に使用される 受信API パス です。 処理後、データはコンテキストデータ変数としてAdobe Analyticsに転送され、mediaReporting.customMetadataの下のAdobe Experience Platformと最上位の統合フィールドとして保存されます。
Adobe Analytics:
- 処理後、カスタムメタデータはコンテキストデータ変数としてAdobe Analyticsに転送されます。
_tenant接頭辞は自動的に削除されるので、処理ルールは_tenantの後のフィールドパスのみを参照します(例:_mycompany.contentCategoryはcontentCategoryになります)。 _dataを介して送信されたデータもAdobe Analyticsに転送され、処理ルールを介して利用できます- 処理ルールを使用して、コンテキストデータ変数をeVar、prop、またはその他のAnalytics変数にマッピングします。 詳しくは、Adobe Experience Platform Edge Networkのデータ変数マッピングを参照してください。
Adobe Experience Platform:
-
カスタムメタデータフィールドは、XDM スキーマのカスタムフィールド(
_mycompanyなど)として定義する必要があり、AEPでフラット化されたフィールドとして保存してクエリできます
-
レポートとクエリの場合、カスタムメタデータは
mediaReporting.customMetadataの下および最上位の統合フィールドとしても使用できます。 ユースケースに最も適したツールを選択します。 -
セグメンテーション、Journey Orchestration、Real-Time CDPのアクティベーションにアクセス可能
動作
- すべてのカスタムメタデータ値は 文字列 である必要があります。 送信前に数値とブール値を変換します。
sessionStart個のメタデータはセッション全体で保持されます。更新には新しいセッションが必要です- 各
adStartおよびchapterStartイベントには、異なるカスタムメタデータを含めることができます - 標準フィールドが存在する場合は、カスタムメタデータよりも標準XDM フィールド (
sessionDetails、advertisingDetails、chapterDetails)を優先する
関連ドキュメント
- カスタムメタデータサポート 。 — MC API (JSON形式)
- Media Collection Details data type — XDM スキーマ参照
- Adobe Experience Platform Edge Networkのデータ変数マッピング — XDM フィールドのAnalytics コンテキストデータマッピング