使用 JavaScript 3.x 跟踪广告

以下说明为使用 3.x SDK 的实施提供了指南。

广告跟踪常量

实施步骤

1. 识别广告时间（包括前置广告）边界开始的时间，然后使用广告时间信息创建 AdBreakObject。

   AdBreakObject 引用：

   变量名称	类型	描述
   name	字符串	非空字符串，表示广告时间名称（前置式广告、中置式广告和后置式广告）。
   position	数字	广告时间的位置编号，从 1 开始编号。
   startTime	数字	广告时间开始的播放头值。

   广告时间对象创建：

   var adBreakObject =
     ADB.Media.createAdBreakObject(<ADBREAK_NAME>,
                                      <POSITION>,
                                      <START_TIME>);
   

2. 在 MediaHeartbeat 实例中使用 AdBreakStart 调用 trackEvent()，以开始跟踪广告时间：

   tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakObject);
   

3. 识别广告的开始时间，然后使用广告信息创建 AdObject 实例。

   AdObject 引用：

   变量名称	类型	描述
   name	字符串	表示广告名称的非空字符串。
   adId	字符串	表示广告标识符的非空字符串。
   position	数字	广告时间中广告的位置编号，从 1 开始编号。
   length	数字	正数，表示广告长度。

   广告对象创建：

   var adObject =
     ADB.Media.createAdObject.createAdObject(<AD_NAME>,
                                   <AD_ID>,
                                   <POSITION>,
                                   <LENGTH>);
   

4. （可选）通过上下文数据变量将标准和/或广告元数据附加到媒体跟踪会话。

   • 在 JavaScript 中实施标准广告元数据

   • 自定义广告元数据 – 对于自定义元数据，请为自定义数据变量创建变量对象，然后使用当前广告的数据进行填充：

     /* Set context data */
     // Standard metadata keys provided by adobe.
     adMetadata[ADB.Media.AdMetadataKeys]  ="Sample Advertiser";
     adMetadata[ADB.Media.AdMetadataKeys] = "Sample Campaign";
     
     // Custom metadata keys
     adMetadata["affiliate"] = "Sample affiliate";
     adMetadata["campaign"] = "Sample ad campaign";
     adMetadata["creative"] = "Sample creative";
     

5. 在 MediaHeartbeat 实例中使用 AdStart 事件调用 trackEvent()，以开始跟踪广告播放。

   在事件调用中添加对自定义元数据变量（或空对象）的引用，以将其作为第三个参数：

   _onAdStart = function() {
       tracker.trackEvent(ADB.Media.Event.AdStart, adObject, adMetadata);
   };
   

6. 当广告播放到达广告结尾时，使用 AdComplete 事件调用 trackEvent()：

   _onAdComplete = function() {
       tracker.trackEvent(ADB.Media.Event.AdComplete);
   };
   

7. 如果由于用户选择跳过广告而使广告播放未能完成，则跟踪 AdSkip 事件：

   _onAdSkip = function() {
       tracker.trackEvent(ADB.Media.Event.AdSkip);
   };
   

8. 如果同一个 AdBreak 中存在任何其他广告，请重复执行步骤 3 至 7。

9. 当广告时间结束时，使用 AdBreakComplete 事件进行跟踪：

   _onAdBreakComplete = function() {
       tracker.trackEvent(ADB.Media.Event.AdBreakComplete);
   };
   

有关更多信息，请参阅跟踪场景包含前置广告的 VOD 播放。

粒度广告跟踪

默认广告ping间隔为 10 seconds.

您可以设置粒度广告跟踪以启用 1 second 广告跟踪。

语法

ADB.Media.MediaObjectKey = {
   GranularAdTracking: "media.granularadtracking"
   }

示例

var mediaObject = ADB.Media.createMediaObject("media-name", "media-id", 60, ADB.Media.StreamType.VOD, ADB.Media.MediaType.Video);

// Enable granular ad tracking
mediaObject[ADB.Media.MediaObjectKey.GranularAdTracking] = true;

tracker.trackSessionStart(mediaObject);