カスタムメタデータのサポート custom-metadata-support

最終更新日： 2026年4月13日

トピック：
Streaming Media

作成対象：

User
Admin
Developer

Media Collection APIを使用すると、カスタムキーと値のペアを、sessionStart、adStart、およびchapterStart イベントの標準パラメーターと共に送信できます。カスタムメタデータは、それぞれのメディア終了イベントとともに Adobe Analytics に転送されます。

このデータをAnalysis Workspaceで利用できるようにするには、カスタム eVarを定義し、ユースケースに応じて処理ルールを設定する必要があります。 eVarまたはpropにマッピングすると、データは、Analytics ソースコネクタが設定されている場合、対応するeVar パスを通じてAdobe Experience Platformでも利用できるようになります。

Experience Edgeを使用するXDM ベースの実装については、カスタムメタデータのサポート - XDM フォーマットを参照してください。

概要

カスタムメタデータは、リクエスト本文にcustomMetadata オブジェクトとして含まれ、params キーと共に配置されます。これは、次の3つのイベントタイプに適用されます。

イベント

メタデータの適用先

sessionStart

メインコンテンツ（セッション全体）

adStart

個人広告

chapterStart

コンテンツの章またはセグメント

構造

カスタムメタデータは、イベントレベルのフラット オブジェクト （キーと値のペア）で、params キーと一緒に使用します。

{
  "playerTime": {
    "playhead": 0,
    "ts": 1646938800000
  },
  "eventType": "sessionStart",
  "params": {
    "analytics.trackingServer": "example.sc.omtrdc.net",
    "analytics.reportSuite": "example-rsid",
    "visitor.marketingCloudOrgId": "0123456789@AdobeOrg",
    "media.id": "sample-video-id",
    "media.length": 3600,
    "media.contentType": "vod",
    "media.playerName": "HTML5 Player",
    "media.channel": "Sports"
  },
  "customMetadata": {
    "field": "value"
  }
}

イベントタイプ別の必須パラメーター

イベント

必須params

sessionStart

analytics.trackingServer, analytics.reportSuite, visitor.marketingCloudOrgId, media.id, media.length, media.contentType, media.playerName, media.channel

adStart

media.ad.id, media.ad.length, media.ad.podPosition, media.ad.playerName

chapterStart

media.chapter.length, media.chapter.offset, media.chapter.index

主要な命名要件

カスタムメタデータキーでmedia.接頭辞を使用しないでください。標準メディアフィールドにマッピングされ、Analytics レポートで上書きされる可能性があります
a.接頭辞はAdobe標準メタデータ用に予約されているため、使用しないでください

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

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

curl -X POST "https://{uri}/api/v1/sessions" \
--header 'Content-Type: application/json' \
--data '{
  "playerTime": {
    "playhead": 0,
    "ts": 1646938800000
  },
  "eventType": "sessionStart",
  "params": {
    "analytics.trackingServer": "example.sc.omtrdc.net",
    "analytics.reportSuite": "example-rsid",
    "analytics.visitorId": "visitor123",
    "visitor.marketingCloudOrgId": "0123456789@AdobeOrg",
    "media.id": "sample-video-id",
    "media.name": "Sample Video",
    "media.length": 3600,
    "media.contentType": "vod",
    "media.playerName": "HTML5 Player",
    "media.channel": "Sports"
  },
  "customMetadata": {
    "contentCategory": "Live Sports",
    "leagueType": "Professional",
    "broadcastRights": "Premium"
  }
}'

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

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

curl -X POST "https://{uri}/api/v1/sessions/{sid}/events" \
--header 'Content-Type: application/json' \
--data '{
  "playerTime": {
    "playhead": 30,
    "ts": 1646938830000
  },
  "eventType": "adStart",
  "params": {
    "media.ad.id": "summer-sale-2026",
    "media.ad.name": "Summer Sale Ad",
    "media.ad.length": 30,
    "media.ad.playerName": "HTML5 Player",
    "media.ad.podPosition": 1
  },
  "customMetadata": {
    "campaignId": "SUMMER2026",
    "targetAudience": "18-34",
    "adFormat": "skippable"
  }
}'

章カスタムメタデータ

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

curl -X POST "https://{uri}/api/v1/sessions/{sid}/events" \
--header 'Content-Type: application/json' \
--data '{
  "playerTime": {
    "playhead": 600,
    "ts": 1646938200000
  },
  "eventType": "chapterStart",
  "params": {
    "media.chapter.friendlyName": "Introduction",
    "media.chapter.length": 300,
    "media.chapter.index": 1,
    "media.chapter.offset": 600
  },
  "customMetadata": {
    "chapterType": "tutorial",
    "difficulty": "beginner",
    "instructor": "Jane Smith"
  }
}'

動作

すべてのカスタムメタデータ値は 文字列 である必要があります。送信前に数値とブール値を変換します。
カスタムメタデータは、c.接頭辞（contentCategory → c.contentCategoryなど）を持つAnalyticsに表示されます。
Analyticsの処理ルールを使用して、カスタムメタデータをeVar、prop、コンテキストデータ変数にマッピングできます
sessionStart個のメタデータはセッション全体で保持されます。更新には新しいセッションが必要です
各adStartおよびchapterStart イベントには、異なるカスタムメタデータを含めることができます