Ad break complete
The ad break complete event signals that all ads in an ad break have finished (either completed or skipped). It closes the ad break opened by Ad break start.
- Prerequisites: Session start, Ad break start
- Associated metric: None
IMPORTANT
Every
adBreakStart must have a matching adBreakComplete. Without the closing bookend, ad events are ignored and ad duration is attributed to main content.Web SDK
Call sendEvent with eventType: "media.adBreakComplete":
alloy("sendEvent", {
xdm: {
eventType: "media.adBreakComplete",
mediaCollection: {
sessionID: "{sid}",
playhead: 0
}
}
});
Mobile SDK
Call trackEvent with the AdBreakComplete event type.
iOS (Swift)
tracker.trackEvent(event: MediaEvent.AdBreakComplete, info: nil, metadata: nil)
Android (Kotlin)
tracker.trackEvent(Media.Event.AdBreakComplete, null, null)
Roku (BrightScript)
Call sendMediaEvent with eventType: "media.adBreakComplete":
m.aepSdk.sendMediaEvent({
"xdm": {
"eventType": "media.adBreakComplete",
"mediaCollection": {
"playhead": 0
}
}
})
Media Edge API
Call the adBreakComplete endpoint:
curl -X POST "https://edge.adobedc.net/ee/va/v1/adBreakComplete?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
"events": [{
"xdm": {
"eventType": "media.adBreakComplete",
"mediaCollection": {
"sessionID": "{sid}",
"playhead": 0
},
"timestamp": "YYYY-08-20T22:41:40+00:00"
}
}]
}'
Media SDK
Call trackEvent with the AdBreakComplete event type:
tracker.trackEvent(ADB.Media.Event.AdBreakComplete, null, null);
Media Collection API
Send an adBreakComplete POST to the events endpoint:
{
"playerTime": { "playhead": 0, "ts": 1699523820000 },
"eventType": "adBreakComplete"
}
recommendation-more-help
media-analytics-help