VAST/VPAID Ad Events

In general, an ad event will fire when the playback of the ad triggers a mechanism that detects a specific activity. An ad event is reported by the VPAID ad tag itself; not the video player.

A VAST/VPAID ad unit can dispatch a number of events that report viewer activity. All events display the name of the VAST/VPAID ad event that occurred:

EVENT DESCRIPTION

AdClickThru

The ad tag reports that the viewer has clicked the video ad and was subsequently redirected to the specified click-through URL.

AdError

The ad tag reports that the viewer cannot play this video ad due to a known (or an unknown) error. This event indicates that the video ad had some type of inherent error, or that the ad request returned a response that did not contain a video ad.

Before dispatching this event, the VPAID ad unit cleans up all video ad assets and cancels any pending video ad playback.

The event will describe the reason for the AdError in a message data field.

If the ad server delivers a null response to the VPAID unit, the message field value will start with “NO AD AVAILABLE” in the message text. This message prefix lets the publisher easily differentiate a “No Ads” AdError from any fatal problem causing an AdError.

For more information about the VPAID standard, see the IAB's VPAID Specification.

The AdError event name may appear simply as "Error."

AdExpandedChange

This event reports that the ad has expanded to a larger frame.

AdImpression

The ad tag reports that an ad impression has occurred. For reporting accuracy, the AdImpression event should only report one time for a given playback event.

In addition, the following events report various types of video ad progress back to the player:

  • AdVideoStart
  • AdVideoFirstQuartile
  • AdVideoMidpoint
  • AdVideoThirdQuartile
  • AdVideoComplete

These events match their VAST events with the same names, as well as the “percent complete” events in the IAB Digital Video In-Stream Ad Metrics Definitions.

Event implementation must be IAB compliant, and must strictly apply to the primary video portion of the ad experience.

AdLinearChange

The ad tag adLinear property value will appear in the info/URL column, ex. adLinear = true.

AdLoaded

The ad tag reports this event to indicate that the video ad is fully loaded and ready to play.

AdLog

The ad sends the AdLog event to the player to relay debugging information, in a parameter string message.AdLog event reporting can help a player engineer debug particular ads.

AdPaused

The ad tag reports that the viewer has paused the video ad.

For more information, see the IAB's description for the pauseAd function.

AdPlaying

The ad tag reports that the viewer has resumed play for this video ad.

For more information, see the IAB's description for the resumeAd function.

AdRemainingTimeChange

The adRemainingTime property value will appear in the info/URL column, recording the time value in seconds, for example: adRemainingTime = 30s

AdStarted

The ad reports this event to indicate that video playback has started for this ad.

Note that an AdStarted event should fire before an AdImpression event; if the AdImpression event fires before the AdStarted event, an error may register in the Event Log. According to the IAB, the AdImpression event is the only official indication of an impression.

AdStopped

The ad tag reports this event to indicate that the ad has stopped playing.

AdUserAcceptInvitation

The ad tag reports that the viewer accepted an invitation extended by the ad.

AdUserClose

The ad tag reports that the viewer has closed the ad.

AdUserMinimize

The ad tag reports that the user has minimized the player and/or the page.

AdVideoComplete

The ad tag reports that the primary video has finished its playback.

AdVideoFirstQuartile

The ad tag reports that the ad has passed by its first playback milestone, that is twenty-five percent of the primary video has played.
Note that the quartiles only measure the primary video, and that the ad could be longer if there are additional interaction points.

AdVideoMidpoint

The ad tag reports that the ad has passed by its second playback milestone, that is, fifty percent of the primary video has played.
Note that the quartiles only measure the primary video, and that the ad could be longer if there are additional interaction points.

AdVideoStart

The ad tag reports that the ad has started its playback.

AdVideoThirdQuartile

The ad tag reports that the ad has passed by its third playback milestone, that is, seventy-five percent of the primary video has played.
Note that the quartiles only measure the primary video, and that the ad could be longer if there are additional interaction points.
AdVolumeChange

The ad tag will display the adVolume property value in the info/URL column, ex. adVolume = 1. Note that the possible values for ad volume are 0-1, with 1 indicating full volume.