Ad skip
The ad skip event signals that the viewer skipped an ad before it finished. Send it when the viewer selects the skip button. Send Ad complete instead if the ad plays to completion.
- Prerequisites: Session start, Ad break start, Ad start
- Associated metric: None
IMPORTANT
This event must be surrounded by
adBreakStart and adBreakComplete bookends, even when a single ad plays. Without these bookends, ad events are ignored and the ad duration is counted as main content duration.Web SDK
Call sendEvent with eventType: "media.adSkip":
alloy("sendEvent", {
xdm: {
eventType: "media.adSkip",
mediaCollection: {
sessionID: "{sid}",
playhead: 5
}
}
});
Mobile SDK
Call trackEvent with the AdSkip event type.
iOS (Swift)
tracker.trackEvent(event: MediaEvent.AdSkip, info: nil, metadata: nil)
Android (Kotlin)
tracker.trackEvent(Media.Event.AdSkip, null, null)
Roku (BrightScript)
Call sendMediaEvent with eventType: "media.adSkip":
m.aepSdk.sendMediaEvent({
"xdm": {
"eventType": "media.adSkip",
"mediaCollection": {
"playhead": 5
}
}
})
Media Edge API
Call the adSkip endpoint:
curl -X POST "https://edge.adobedc.net/ee/va/v1/adSkip?configId={datastreamID}" \
--header 'Content-Type: application/json' \
--data '{
"events": [{
"xdm": {
"eventType": "media.adSkip",
"mediaCollection": {
"sessionID": "{sid}",
"playhead": 5
},
"timestamp": "YYYY-08-20T22:41:40+00:00"
}
}]
}'
Media SDK
Call trackEvent with the AdSkip event type:
tracker.trackEvent(ADB.Media.Event.AdSkip, null, null);
Media Collection API
Send an adSkip POST to the events endpoint:
{
"playerTime": { "playhead": 5, "ts": 1699523820000 },
"eventType": "adSkip"
}
recommendation-more-help
media-analytics-help