ドキュメントAnalyticsストリーミングメディアコレクションガイド

広告パラメーター ad-parameters

Last update: Fri Oct 04 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • ユーザー
  • 管理者
  • 開発者

このトピックでは、コンテキストデータ値など、アドビがソリューション変数を通じて収集するビデオ広告データのリストを示します。

表のデータの説明は次のとおりです。

  • 実装： ​実装に関する値と要件の詳細。

    • キー - 変数。アプリで手動で設定するか、Adobe Media SDK によって自動的に設定されます。
    • 必須  - 基本的なビデオトラッキングでパラメーターが必須かどうかを表します。
    • 型 - 設定する変数の型（文字列または数値）を表します。
    • 送信タイミング - データが送信されるタイミング。メディア開始 ​の場合はメディアの開始時に分析の呼び出しが送信され、広告開始 ​の場合は広告の開始時に分析の呼び出しが送信されます。終了 ​の場合は、メディアセッションや広告、チャプターなどの終了時に、コンパイル済みの分析の呼び出しがハートビートサーバーから分析サーバーに直接送信されます。終了の呼び出しは、ネットワークパケットの呼び出しでは利用できません。
    • 最小のSDK のバージョン - パラメーターにアクセスするのに必要な SDK のバージョン。
    • 値の例  - 変数の一般的な利用方法の例。

  • ネットワークパラメーター： Adobe Analytics またはハートビートサーバーに渡される値。この列には、Adobe Media SDK によって生成されるネットワーク呼び出しに含まれるパラメーターの名前が示されています。

  • レポート： ​ビデオデータの確認方法と分析方法に関する詳細。

    • 利用可能 - デフォルトでもデータをレポートで確認できる場合は​ 可、カスタム設定が必要な場合は​ カスタム。
    • 予約変数  - 予約変数で取得されるデータの形式（イベント、eVar、prop または分類）。
    • レポート名  - Adobe Aanlytics の変数のレポート名。
    • コンテキストデータ  - レポートサーバーに渡され、処理ルールで使用される Adobe Analytics のコンテキストデータの名前。
    • データフィード  - クリックストリームまたはライブストリームデータフィード内の変数の列の名前。
    • Audience Manager - Adobe Audience Manager 内の特性名。
IMPORTANT
以下にリストされている変数で、レポート／予約変数に「分類」と説明されている変数の分類名を変更しないでください
。
メディア分類は、レポートスイートでメディアトラッキングが有効にされる際に定義されます
。アドビは新しいプロパティを追加することがありますが、その場合、
新しいメディアプロパティにアクセスするには、レポートスイートを再有効化する必要があります
。更新処理の際に、アドビは、変数の名前をチェックすることで、
分類が有効にされているかどうかを判別します。見つからない
変数名がある場合、アドビは、分類を再追加します。

広告ビデオデータ ad-video-data

広告 ID

実装
ネットワークパラメーター
レポート
  • SDK キー：
    adId
  • API キー：
    media.ad.id
  • 必須：
    ​はい
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     2125
  • 説明：
    ​広告の ID。（整数と文字の組み合わせ）。
  • Adobe Analytics：
    （a.media.ad.
    name）
  • ハートビート：
    （s:asset:ad_id）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​訪問時
  • レポート名：
    ​広告
  • コンテキストデータ：
    （a.media.ad.
    name）
  • データフィード：
    videoad
  • Audience Manager：
    （c_contextdata.
    a.media.ad.name）
  • XDM フィールドパス
    ：advertising.adAssetReference@id
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.name
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.name

ポッド位置の広告

実装
ネットワークパラメーター
レポート
  • SDK キー：
    position
  • API キー：
    media.ad.podPosition
  • 必須：
    ​はい
  • 型：
    ​数値
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     1
  • 説明：
    ​親広告ブレーク内の広告の位置（インデックス）。最初の広告のインデックスは 0、2 番目の広告のインデックスは 1（以下同様）。
  • Adobe Analytics：
    （a.media.ad.
    podPosition）
  • ハートビート：
    （s:asset:pod_position）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​ポッド位置の広告
  • コンテキストデータ：
    （a.media.ad.
    podPosition）
  • データフィード：
    videoadinpod
  • Audience Manager：
    （c_contextdata.
    a.media.ad.podPosition）
  • XDM フィールドパス
    a: dvertising.adAssetViewDetails.index
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.podPosition
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.podPosition

広告の長さ

実装
ネットワークパラメーター
レポート
  • SDK キー：
    length
  • API キー：
    media.ad.length
  • 必須：
    ​はい
  • 型：
    ​数値
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.1
  • 値の例：
     「15」
  • 説明：
    ​ビデオ広告の長さ（秒）。
  • Adobe Analytics：
    （a.media.ad.
    length）
  • ハートビート：
    （l:asset:ad_length）
  • 利用可能：
    ​可
  • 予約変数：
    eVar および分類
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​広告の長さおよび広告の長さ（変数）
  • コンテキストデータ：
    （a.media.ad.
    length）
  • データフィード：
    videoadlength
  • Audience Manager：
    （c_contextdata.
    a.media.ad.length）
  • XDM フィールドのパス
    ：advertising.adAssetReference
    xmpDM:duration
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.length
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.length

広告プレーヤー名

実装
ネットワークパラメーター
レポート
  • SDK キー：
    playerName
  • API キー：
    media.ad.playerName
  • 必須：
    ​はい
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     「Freewheel」
  • 説明：
    ​広告のレンダリングをおこなうプレーヤーの名前。
  • Adobe Analytics：
    （a.media.ad.
    playerName）
  • ハートビート：
    （s:sp:player_name）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​広告プレーヤー名
  • コンテキストデータ：
    （a.media.ad.
    playerName）
  • データフィード：
    videoadplayername
  • Audience Manager：
    （c_contextdata.
    a.media.ad.playerName）
  • XDM フィールドパス
    ：advertising.adAssetViewDetails.playerName
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.
    playerName
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.
    playerName

広告ブレーク名

実装
ネットワークパラメーター
レポート
  • SDK キー：
    name
  • API キー：
    media.ad.podFriendlyName
  • 必須：
    SDK：はい、API：いいえ。
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     「pre-roll」
  • 説明：
    ​広告ブレークのわかりやすい名前。
  • Adobe Analytics：
    （a.media.ad.
    podFriendlyName）
  • ハートビート：
    （s:asset:pod_name）
  • 利用可能：
    ​可
  • 予約変数：
    ​分類
  • レポート名：
    ​ポッド名
  • コンテキストデータ：
    （a.media.ad.
    podFriendlyName）
  • データフィード：
    ​なし
  • Audience Manager：
    （c_contextdata.
    a.media.ad.podFriendlyName）
  • XDM フィールドのパス：
    advertising.adAssetViewDetails.
    adBreak.dc:title
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingPodDetails.
    friendlyName
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingPodDetails.
    friendlyName

広告ブレークインデックス

実装
ネットワークパラメーター
レポート
  • SDK キー：
    position
  • API キー：
    media.ad.podIndex
  • 必須：
    ​はい
  • 型：
    ​数値
  • 送信タイミング：
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     1
  • 説明：
    ​コンテンツ内の広告ブレークのインデックス（1 から開始）。このプロパティは、メディア SDK でポッド ID を生成するために  のみ  使用します。
  • Adobe Analytics：
  • ハートビート：
  • 利用可能：
    ​不可
  • 予約変数：
    ​なし
  • レポート名：
    ​なし
  • コンテキストデータ：
  • データフィード：
    ​なし
  • Audience Manager：
  • XDM フィールドパス
    ：advertising.adAssetViewDetails.index
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingPodDetails.index

広告ブレークの位置

実装
ネットワークパラメーター
レポート
  • SDK キー：
    startTime
  • API キー：
    media.ad.podSecond
  • 必須：
    ​はい
  • 型：
    ​数値
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     90
  • 説明：
    ​コンテンツ内の広告ブレークのオフセット（秒）。
  • Adobe Analytics：
    （a.media.ad.
    podSecond）
  • ハートビート：
    （l:asset:pod_offset）
  • 利用可能：
    ​可
  • 予約変数：
    ​分類
  • レポート名：
    ​ポッド位置
  • コンテキストデータ：
    （a.media.ad.
    podSecond）
  • データフィード：
    ​なし
  • Audience Manager：
    （c_contextdata.
    a.media.ad.podSecond）
  • XDM フィールドのパス
    ：advertising.adAssetViewDetails.adBreak.
    offset
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingPodDetails.
    offset
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingPodDetails.
    offset

広告ブレーク ID

実装
ネットワークパラメーター
レポート
  • SDK キー：
    ​自動設定
  • API キー：
    ​なし
  • 必須：
    ​はい
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     c4a577424c84067899b807c76722d495_1
  • Adobe Analytics：
    （a.media.ad.
    pod）
  • ハートビート：
    （s:asset:pod_id）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​広告ポッド
  • コンテキストデータ：
    （a.media.ad.
    pod）
  • データフィード：
    videoadpod
  • Audience Manager：
  • XDM フィールドパス
    ：advertising.adAssetViewDetails.adBreak.@id
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingPodDetails.
    ID

広告名

実装
ネットワークパラメーター
レポート
  • SDK キー：
    name
  • API キー：
    media.ad.name
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.1
  • 値の例：
     「Ford F-150」
  • 説明：
    ​広告のわかりやすい名前。レポートでは、「広告名」が分類、「広告名（変数）」が eVar です。
  • Adobe Analytics：
    （a.media.ad.
    friendlyName）
  • ハートビート：
    （s:asset:ad_name）
  • 利用可能：
    ​可
  • 予約変数：
    eVar および分類
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​広告名および広告名（変数）
  • コンテキストデータ：
    （a.media.ad.
    friendlyName）
  • データフィード：
    ​なし
  • Audience Manager：
    （c_contextdata.
    a.media.ad.friendlyName）
  • XDM フィールドパス
    ：advertising.adAssetReference.dc:title
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.friendlyName
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.friendlyName

標準の広告メタデータ standard-ad-metadata

広告主

実装
ネットワークパラメーター
レポート
  • SDK キー：
    ADVERTISER
  • API キー：
    media.ad.advertiser
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.7
  • 値の例：
  • 説明：
    ​広告で商品が取り上げられる会社またはブランド。
  • Adobe Analytics：
    （a.media.ad.
    advertiser）
  • ハートビート：
    （s:meta:
    a.media.ad.advertiser）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    広告主
  • コンテキストデータ：
    （a.media.ad.
    advertiser）
  • データフィード：
    videoadvertiser
  • Audience Manager：
    （c_contextdata.
    a.media.ad.advertiser）
  • XDM フィールドパス
    ：advertising.adAssetReference.advertiser
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.advertiser
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.advertiser

キャンペーン ID

実装
ネットワークパラメーター
レポート
  • SDK キー：
    CAMPAIGN_ID
  • API キー：
    media.ad.campaignId
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.7
  • 値の例：
     整数、または名前（文字列）。
  • 説明：
    ​広告キャンペーンの ID。
  • Adobe Analytics：
    （a.media.ad.
    campaign）
  • ハートビート：
    （s:meta:
    a.media.ad.campaign）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    キャンペーン ID
  • コンテキストデータ：
    （a.media.ad.
    campaign）
  • データフィード：
    videocampaign
  • Audience Manager：
    （c_contextdata.
    a.media.ad.campaign）
  • XDM フィールドパス
    ：advertising.adAssetReference.campaign
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.
    campaignID
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.
    campaignID

クリエイティブ ID

実装
ネットワークパラメーター
レポート
  • SDK キー：
    CREATIVE_ID
  • API キー：
    media.ad.creativeId
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.7
  • 値の例：
     整数、または名前（文字列）。
  • 説明：
    ​広告クリエイティブの ID。
  • Adobe Analytics：
    （a.media.ad.
    creative）
  • ハートビート：
    （s:meta:
    a.media.ad.creative）
  • 利用可能：
    ​可
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    クリエイティブ ID
  • コンテキストデータ：
    （a.media.ad.
    creative）
  • データフィード：
    adclassificationcreative
  • Audience Manager：
    （c_contextdata.
    a.media.ad.creative）
  • XDM フィールドパス
    ：advertising.adAssetReference.creativeID
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.creativeID
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.creativeID

サイト ID

実装
ネットワークパラメーター
レポート
  • SDK キー：
    SITE_ID
  • API キー：
    media.ad.siteId
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.7
  • 値の例：
  • 説明：
    ​広告サイトの ID。
  • Adobe Analytics：
    （a.media.ad.
    site）
  • ハートビート：
    （s:meta:
    a.media.ad.site）
  • 利用可能：
    カスタムの処理ルールを使用
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​カスタム
  • コンテキストデータ：
    （a.media.ad.
    site）
  • データフィード：
    ​なし
  • Audience Manager：
    （c_contextdata.
    a.media.ad.site）
  • XDM フィールドパス
    ：advertising.adAssetReference.siteID
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.siteID
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.siteID

クリエイティブ URL

実装
ネットワークパラメーター
レポート
  • SDK キー：
    CREATIVE_URL
  • API キー：
    media.ad.creativeURL
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.7
  • 値の例：
  • 説明：
    ​広告クリエイティブの URL。
  • Adobe Analytics：
    （a.media.ad.
    creativeURL）
  • ハートビート：
    （s:meta:<c/ode> a.media.ad.creativeURL） ``
  • 利用可能：
    カスタムの処理ルールを使用
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​カスタム
  • コンテキストデータ：
    （a.media.ad.
    creativeURL）
  • データフィード：
    ​なし
  • Audience Manager：
    （c_contextdata.
    a.media.ad.creativeURL）
  • XDM フィールドパス
    ：advertising.adAssetReference.creativeURL
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.
    creativeURL
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.
    creativeURL

プレースメント ID

実装
ネットワークパラメーター
レポート
  • SDK キー：
    PLACEMENT_ID
  • API キー：
    media.ad.placementId
  • 必須：
    ​いいえ
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始、広告の終了
  • 最小のSDK のバージョン： 1.5.7
  • 値の例：
  • 説明：
    ​広告のプレースメント ID。
  • Adobe Analytics：
    （a.media.ad.
    placement）
  • ハートビート：
    （s:meta:
    a.media.ad.placement）
  • 利用可能：
    カスタムの処理ルールを使用
  • 予約変数：
    eVar
  • 有効期限：
    ​ヒット時
  • レポート名：
    ​カスタム
  • コンテキストデータ：
    （a.media.ad.
    placement）
  • データフィード：
    ​なし
  • Audience Manager：
    （c_contextdata.
    a.media.ad.placement）
  • XDM フィールドパス
    ：advertising.adAssetReference.placementID
  • コレクション XDM フィールドのパス：
    mediaCollection.advertisingDetails.
    placementID
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.
    placementID

広告指標 ad-metrics

広告開始

実装
ネットワークパラメーター
レポート
  • SDK キー：
    ​自動設定
  • API キー：
    ​なし
  • 必須：
    ​はい
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告開始
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     TRUE
  • 説明：
    ​ビデオ広告の開始数。
  • Adobe Analytics：
    （a.media.ad.
    view）
  • ハートビート：
    （s:event:type=start）
    （s:asset:type=ad） ``
  • 利用可能：
    ​可
  • 予約変数：
    ​イベント
  • レポート名：
    ​広告開始
  • データフィード：
    ​なし
  • コンテキストデータ：
    （a.media.ad.
    view）
  • Audience Manager：
    （c_contextdata.
    a.media.ad.view）
  • XDM フィールドパス
    ：advertising.starts.value > 0 => 「TRUE」
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.isStarted

広告完了

実装
ネットワークパラメーター
レポート
  • SDK キー：
    ​自動設定
  • API キー：
    ​なし
  • 必須：
    ​はい
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     TRUE
  • 説明：
    ​ビデオ広告の完了数。
  • Adobe Analytics：
    （a.media.ad.
    complete）
  • ハートビート：
    （s:event:type=complete）
    （s:asset:type=ad）
  • 利用可能：
    ​可
  • 予約変数：
    ​イベント
  • レポート名：
    ​広告完了
  • データフィード：
    ​なし
  • コンテキストデータ：
    （a.media.ad.
    complete）
  • Audience Manager：
    （c_contextdata.
    a.media.ad.complete）
  • XDM フィールドパス
    ：advertising.completes.value > 0 => 「TRUE」
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.
    isCompleted

広告滞在時間

実装
ネットワークパラメーター
レポート
  • SDK キー：
    ​自動設定
  • API キー：
    ​なし
  • 必須：
    ​はい
  • 型：
    ​文字列
  • 送信タイミング：
    ​広告の終了
  • 最小のSDK のバージョン： ​すべて可
  • 値の例：
     15
  • 説明：
    ​広告の合計視聴時間（再生秒数）。値は時間形式（HH:MM:SSAnalysis Workspace）に設定する必要があります。 データフィード、Data Warehouse およびレポート API では、値は秒単位で表示されます。
    リリース日：2018 年 9 月 13 日
  • Adobe Analytics：
    （a.media.ad.
    timePlayed）
  • ハートビート：
  • 利用可能：
    ​可
  • 予約変数：
    ​イベント
  • レポート名：
    ​広告滞在時間
  • データフィード：
    ​なし
  • コンテキストデータ：
    （a.media.ad.
    timePlayed）
  • Audience Manager：
    （c_contextdata.
    a.media.ad.timePlayed）
  • XDM フィールドパス
    ：advertising.timePlayed.value
  • レポート XDM フィールドのパス：
    mediaReporting.advertisingDetails.
    timePlayed

createAdObject API：

createAdBreakObject API：

MediaHeartbeatConfig API：

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb