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.

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":

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.adSkip",
    mediaCollection: {
      sessionID: "{sid}",
      playhead: 5
    }
  }
});
iOS

Call trackEvent with the AdSkip event type.

code language-swift
tracker.trackEvent(event: MediaEvent.AdSkip, info: nil, metadata: nil)
Android

Call trackEvent with the AdSkip event type.

code language-kotlin
tracker.trackEvent(Media.Event.AdSkip, null, null)
Roku Edge

Call sendMediaEvent with eventType: "media.adSkip":

code language-brightscript
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.adSkip",
        "mediaCollection": {
            "playhead": 5
        }
    }
})
Media Edge API

Call the adSkip endpoint:

code language-sh
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"
    }
  }]
}'

Legacy implementation types (Analytics-only)

Media SDK JS 3.x

Call trackEvent with the AdSkip event type:

code language-javascript
tracker.trackEvent(ADB.Media.Event.AdSkip, null, null);
Chromecast

Call trackEvent with the AdSkip event type:

code language-javascript
ADBMobile.media.trackEvent(ADBMobile.media.Event.AdSkip);
Roku 2.x

Call mediaTrackEvent with the MEDIA_AD_SKIP event type:

code language-brightscript
adb = ADBMobile()
adb.mediaTrackEvent(adb.MEDIA_AD_SKIP)
Media Collection API

Send an adSkip POST to the events endpoint:

code language-json
{
  "playerTime": { "playhead": 5, "ts": 1699523820000 },
  "eventType": "adSkip"
}
recommendation-more-help
media-analytics-help