Track ads on iOS

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:

id adBreakObject = [ADBMediaHeartbeat createAdBreakObjectWithName:[ADBREAK_NAME]
                            position:[POSITION]
                            startTime:[START_TIME]];

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

- (void)onAdBreakStart:(NSNotification *)notification {
    [_mediaHeartbeat trackEvent:ADBMediaHeartbeatEventAdBreakStart
                     mediaObject:adBreakObject
                     data:nil];
}

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

AdObject reference:

Ad object creation:

id adObject = [ADBMediaHeartbeat createAdObjectWithName:[AD_NAME]
                                 adId:[AD_ID]
                                 position:[POSITION]
                                 length:[LENGTH]];

Optionally attach standard and/or ad metadata to the media tracking session through context data variables.

• Implement standard ad metadata on iOS

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

  NSMutableDictionary *adDictionary = [[NSMutableDictionary alloc] init];
  [adDictionary setObject:@"Sample affiliate" forKey:@"affiliate"];
  [adDictionary setObject:@"Sample campaign" forKey:@"campaign"];
  [adDictionary setObject:@"Sample creative" forKey:@"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:

- (void)onAdStart:(NSNotification *)notification {
    [_mediaHeartbeat trackEvent:ADBMediaHeartbeatEventAdStart
                     mediaObject:adObject
                     data:adDictionary];
}

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

- (void)onAdComplete:(NSNotification *)notification {
    [_mediaHeartbeat trackEvent:ADBMediaHeartbeatEventAdComplete
                     mediaObject:nil
                     data:nil];
}

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

- (void)onAdSkip:(NSNotification *)notification {
    [_mediaHeartbeat trackEvent:ADBMediaHeartbeatEventAdSkip
                     mediaObject:nil
                     data:nil];
}

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:

- (void)onAdBreakComplete:(NSNotification *)notification {
    [_mediaHeartbeat trackEvent:ADBMediaHeartbeatEventAdBreakComplete
                     mediaObject:nil
                     data:nil];
}