Track ads using JavaScript 3.x

Identify when the ad break boundary begins, including pre-roll, and create an AdBreakObject by using the ad break information.

AdBreakObject reference:

Ad break object creation:

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

Call trackEvent() with AdBreakStart in the MediaHeartbeat instance to begin tracking the ad break:

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

Identify when the ad starts and create an AdObject instance using the ad information.

AdObject reference:

Ad object creation:

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

(Optional) Attach standard and/or ad metadata to the media tracking session through context data variables.

• Implement standard ad metadata on JavaScript

• Custom ad metadata - For custom metadata, create a variable object for the custom data variables and populate with the data for the current ad:

  /* 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";
  

Call trackEvent() with the AdStart event in the MediaHeartbeat instance to begin tracking the ad playback.

Include a reference to your custom metadata variable (or an empty object) as the third parameter in the event call:

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

When the ad playback reaches the end of the ad, call trackEvent() with the AdComplete event:

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

If ad playback did not complete because the user chose to skip the ad, track the AdSkip event:

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

If there are any additional ads within the same AdBreak, repeat steps 3 through 7 again.

When the ad break is complete, use the AdBreakComplete event to track:

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