文件Analytics串流媒體收集指南

廣告參數 ad-parameters

Last update: Fri Oct 04 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • 使用者
  • 管理員
  • 開發人員

本主題介紹影片廣告資料，包含 Adobe 透過解決方案變數收集的內容資料值。

表格資料說明:

  • 實施： ​實施數值和需求的資訊

    • 索引鍵 - 在您的應用程式中手動設定，或由 Adobe Media SDK 自動設定的變數。
    • 必要 - 指出基本影片追蹤是否需要參數。
    • 類型 - 指明預計設定的變數類型 (字串或數字)。
    • 「伴隨傳送」- 指出資料傳送的時間:「媒體開始」 ​為媒體開始時傳送的分析呼叫、「廣告開始」 ​為廣告開始時傳送的分析呼叫等等；「關閉」 ​呼叫為媒體工作階段結束或廣告、章節等項目結束時，直接從心率伺服器傳送到分析伺服器的已編譯分析呼叫。網路封包呼叫中使用無法使用關閉呼叫。
    • 最小SDK 版本 - 指出您存取參數所需的 SDK 版本。
    • 樣本值 - 提供常見的變數使用方法範例。

  • 網路參數： ​顯示傳遞至 Adobe Analytics 或心率伺服器的數值。本欄顯示可於網路呼叫中看到，且由 Adobe Media SDK 產生的參數名稱。

  • 報表： ​關於如何檢視和分析影片資料的資訊。

    • 可用 - 指出資料是否已由報表預設提供 (是)，或是需要自行設定 (自訂)
    • 保留變數 - 指出資料在保留變數中是否被當作事件、eVar、prop 或分類擷取。
    • 報表名稱 - 適用於變數的 Adobe Aanlytics 報表名稱
    • 內容資料 - 傳遞至報表伺服器以及用於處理規則的 Adobe Aanlytics 內容資料名稱。
    • 資料摘要 - 可在 Clickstream 或 Live Stream 資料摘要中找到的變數欄名稱
    • Audience Manager - Adobe Audience Manager 中的特徵名稱
IMPORTANT
請勿變更下列任何變數的分類名稱，
其說明以「分類」形式顯示於「報表/保留變數」下方。
為媒體追蹤啟用報表套裝時，系統會定義
媒體分類。Adobe 有時會新增屬性，而發生這種情形時，
客戶必須重新啟用其報表套裝才能存取新的媒體
屬性。在更新程序期間，Adobe 會檢查
變數名稱，藉此決定是否啟用分類。如果有任何
變數名稱遺失，Adobe 會再次新增遺失的項目。

廣告影片資料 ad-video-data

廣告 ID

實施
網路參數
報表
  • SDK 索引鍵:
    adId
  • API 索引鍵:
    media.ad.id
  • 必要:
    ​是
  • 類型:
    ​字串
  • 伴隨傳送:
    ​廣告開始、廣告關閉
  • 最小SDK 版本: 任何版本
  • 樣本值：
    「2125」
  • 說明:
    ​廣告 ID。(任何整數和/或字母的組合)
  • Adobe Analytics:
    (a.media.ad.
    名稱)
  • 心率：
    (s:asset:ad_id)
  • 可用:
    ​是
  • 預留變數:
    eVar
  • 過期時間:
    ​造訪時
  • 報表名稱:
    ​廣告
  • 內容資料:
    (a.media.ad.
    名稱)
  • 資料摘要:
    videoad
  • Audience Manager:
    (c_contextdata.
    a.media.ad.name)
  • XDM 欄位路徑:
    advertising.adAssetReference。@id
  • 集合 XDM 欄位路徑:
    mediaCollection.advertisingDetails.name
  • 報告 XDM 欄位路徑:
    mediaReporting.advertisingDetails.name

Pod 位置中的廣告

實施
網路參數
報表
  • SDK 索引鍵:
    position
  • API 索引鍵:
    media.ad.podPosition
  • 必要:
    ​是
  • 類型:
    ​數字
  • 伴隨傳送:
    ​廣告開始、廣告關閉
  • 最小SDK 版本: 任何版本
  • 樣本值：
    1
  • 說明:
    ​上層廣告插播內的廣告位置 (索引)。第一個廣告索引為 0，第二個廣告索引為 1，以此類推。
  • Adobe Analytics:
    (a.media.ad.
    podPosition)
  • 心率：
    (s:asset:pod_position)
  • 可用:
    ​是
  • 預留變數:
    eVar
  • 過期時間:
    ​點擊時
  • 報表名稱:
    Pod 位置中的廣告
  • 內容資料:
    (a.media.ad.
    podPosition)
  • 資料摘要:
    videoadinpod
  • Audience Manager:
    (c_contextdata.
    a.media.ad.podPosition)
  • XDM 欄位路徑:
    advertising.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)
  • 可用:
    ​是
  • 預留變數:
    ​分類
  • 報表名稱:
    Pod 名稱
  • 內容資料:
    (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 開始的廣告插播索引。此屬性​ 僅 ​由 Media SDK 用於產生 Pod 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)
  • 可用:
    ​是
  • 預留變數:
    ​分類
  • 報表名稱:
    Pod 位置
  • 內容資料:
    (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
  • 過期時間:
    ​點擊時
  • 報表名稱:
    ​廣告 Pod
  • 內容資料:
    (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.
    網站)
  • 心率：
    (s:meta:
    a.media.ad.site)
  • 可用:
    使用自訂處理規則
  • 預留變數:
    eVar
  • 過期時間:
    ​點擊時
  • 報表名稱:
    ​自訂
  • 內容資料:
    (a.media.ad.
    網站)
  • 資料摘要:
    ​不適用
  • 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.
    檢視)
  • 心率：
    (s:event:type=start(s:asset:type=ad) ``
  • 可用:
    ​是
  • 預留變數:
    ​事件
  • 報表名稱:
    ​廣告開始
  • 資料摘要:
    ​不適用
  • 內容資料:
    (a.media.ad.
    檢視)
  • 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:SS)顯示Analysis Workspace )和Reports & Analytics中。 在資料摘要、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