概述

重要

下列指示提供使用 2.x SDK 實作的指引。若您正在實作 SDK 1.x 版，您可以在此處下載 1.x 開發人員指南: 下載 SDK。

廣告播放包含追蹤廣告插播、廣告開始、廣告完成，以及廣告略過。請使用媒體播放器的 API 來識別重要的播放器事件，並填入必要和選用的廣告變數。請在此處參閱完整的中繼資料清單: 廣告參數。

播放器事件

在廣告插播開始時

注意

包括前段廣告

為廣告插播建立 adBreak 物件例項，例如, adBreakObject.
使用 trackEvent 呼叫廣告插播開始的 adBreakObject。

在每個廣告資產開始時

為廣告資產建立廣告物件例項，例如, adObject.
填入廣告中繼資料 adCustomMetadata。
呼叫廣告開始的 trackEvent。

在每個廣告完成時

呼叫廣告完成的 trackEvent。

在廣告略過時

呼叫廣告略過的 trackEvent。

在廣告插播完成時

呼叫廣告插播完成的 trackEvent。

實作廣告追蹤

廣告追蹤常數

常數名稱	說明
`AdBreakStart`	用於追蹤廣告插播開始事件的常數
`AdBreakComplete`	用於追蹤廣告插播事件的常數
`AdStart`	用於追蹤廣告開始事件的常數
`AdComplete`	用於追蹤廣告完成事件的常數
`AdSkip`	用於追蹤廣告略過事件的常數

實施步驟

識別廣告插播界限何時開始 (包括前段)，並使用廣告插播資訊建立 AdBreakObject。

AdBreakObject 參考資料:

變數名稱	說明	必填
`name`	廣告插播名稱，例如前段、中段和後段。	是
`position`	內容中廣告插播的編號位置從 1 開始。	是
`startTime`	廣告插播開始時的播放點值。	是

在 MediaHeartbeat 例項中使用 AdBreakStart 呼叫 trackEvent() 以開始追蹤廣告插播。

識別廣告何時開始，並使用廣告資訊建立 AdObject 例項。

AdObject 參考資料:

變數名稱	說明	必填
`name`	廣告的易記名稱。	是
`adId`	廣告的唯一識別碼。	是
`position`	廣告插播中的廣告編號位置從 1 開始。	是
`length`	廣告長度	是

可選擇透過內容資料變數，將標準和/或廣告中繼資料附加到追蹤工作階段。
- 標準廣告中繼資料 - 對於標準廣告中繼資料，請使用平台的索引鍵，建立標準廣告中繼資料索引鍵值配對的字典。
- 自訂廣告中繼資料 - 對於自訂中繼資料，請建立自訂資料變數的變數物件，並填入目前廣告的資料。
在 MediaHeartbeat 例項中使用 AdStart 事件呼叫 trackEvent() 以開始追蹤廣告播放。

將參考加入您的自訂中繼資料變數 (或空白物件)，作為事件呼叫中的第三個參數。
當廣告播放達到廣告結尾時，請使用 AdComplete 事件呼叫 trackEvent()。
如果由於使用者選擇略過廣告而導致廣告播放未完成，請追蹤 AdSkip 事件.
如果在相同 AdBreak 內有任何其他廣告，請再次重複步驟 3 到 7。
當廣告插播完成時，請使用 AdBreakComplete 事件加以追蹤.

重要

請勿在廣告播放期間 (s:asset:type=ad) 增加內容播放器播放點 (l:event:playhead)。若這麼做，會對「內容逗留時間」量度產生不利的影響。

以下程式碼範例將 JavaScript 2.x SDK 用於 HTML5 媒體播放器。

/* Call on ad break start */ 
 
if (e.type == "ad break start") { 
    var adBreakObject = MediaHeartbeat.createAdBreakObject("mid-roll", 2, 500); 
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakStart, adBreakObject); 
}; 
 
/* Call on ad start */ 
if (e.type == "ad start") { 
    var adObject = MediaHeartbeat.createAdObject("PepsiOne", "123456ab", 1, 30); 
    /* Set custom context data */ 
    var adCustomMetadata = { 
        affiliate:"Sample affiliate", 
        campaign:"Sample ad campaign", 
        creative:"Sample creative" 
    } 
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdStart, adObject, adCustomMetadata); 
}; 
 
/* Call on ad complete */ 
if (e.type == "ad complete") { 
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdComplete); 
}; 
 
/* Call on ad skip */ 
if (e.type == "ad skip") { 
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdSkip); 
}; 
     
/* Call on ad break complete */ 
if (e.type == "ad break complete") { 
    this.mediaHeartbeat.trackEvent(MediaHeartbeat.Event.AdBreakComplete); 
};

概述