Ad break name

This page covers data collection for the Ad break name variable. See Pod name for the corresponding reporting dimension.

The ad break name variable is the friendly name of the ad break (for example, "pre-roll", "mid-roll-1", "post-roll"). The value is set on the ad-break object, not on individual ads.

Web SDK

Set friendlyName inside mediaCollection.advertisingPodDetails when calling sendEvent for media.adBreakStart:

alloy("sendEvent", {
  xdm: {
    eventType: "media.adBreakStart",
    mediaCollection: {
      advertisingPodDetails: {
        friendlyName: "pre-roll",
        index: 1,
        offset: 0
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});

Mobile SDK

Pass the ad break name as the first (name) argument to createAdBreakObject, then track the ad-break-start event before the ad-start event.

iOS (Swift)

let adBreakObject = Media.createAdBreakObjectWith(name: "pre-roll",
                                              position: 1,
                                             startTime: 0)

tracker.trackEvent(event: MediaEvent.AdBreakStart, info: adBreakObject, metadata: nil)

Android (Kotlin)

val adBreakObject = Media.createAdBreakObject("pre-roll",
                                              1L,
                                              0.0)

tracker.trackEvent(Media.Event.AdBreakStart, adBreakObject, null)

Roku (BrightScript)

Set friendlyName inside mediaCollection.advertisingPodDetails when calling sendMediaEvent for media.adBreakStart:

m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adBreakStart",
        "mediaCollection": {
            "advertisingPodDetails": {
                "friendlyName": "pre-roll",
                "index": 1,
                "offset": 0
            },
            "playhead": 0
        }
    }
})

Media Edge API

Call the adBreakStart endpoint with friendlyName inside mediaCollection.advertisingPodDetails:

{
  "events": [{
    "xdm": {
      "eventType": "media.adBreakStart",
      "mediaCollection": {
        "advertisingPodDetails": {
          "friendlyName": "pre-roll",
          "index": 1,
          "offset": 0
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

Media SDK

Pass the ad break name as the first argument to ADB.Media.createAdBreakObject:

var adBreakInfo = ADB.Media.createAdBreakObject(
  "pre-roll",
  1,
  0
);

tracker.trackEvent(ADB.Media.Event.AdBreakStart, adBreakInfo, null);

Media Collection API

Include media.ad.podFriendlyName in the params object of your adBreakStart POST request:

{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "adBreakStart",
  "params": {
    "media.ad.podFriendlyName": "pre-roll"
  }
}

See the Media Collection API events reference for the full request structure.