...
Event name | Description | ||
---|---|---|---|
AdLoaded onLoad | Indicates the first time an ad sources triggered the AdLoaded event | ||
AdReady | Fires on every ad AdLoaded event of any ad | ||
AdEvent onEvent | Granular vast and request bid events per ad source
vpaid progress events:
| ||
AdImpression onPlay | Called when there is a video impression.
| ||
AdVideoFirstQuartile onPlay25 | Called when the ad reached 25% of the ad video | ||
AdVideoMidpoint onPlay50 | Called when the ad reached 50% of the ad video | ||
AdVideoThirdQuartile onPlay75 | Called when the ad reached 75% of the ad video | ||
AdVideoComplete onPlay100 | Called when the ad completed | ||
AdClickThru onClick | Called when the ad is clicked on | ||
AdPaused onPause | Called when the ad is paused | ||
AdPlaying onResume | Called when the ad starts playing or resumed | ||
AdError onError | Called by the player every time it finish running 1 + vastRetry waterfall runs without impression Called also whenever the player decides that it should stop running, for example when maxImp or maxRun is reached, in this case the event will pass a parameter: {errorlimit: true} to indicate the player is stopping calls for ads | ||
AdStopped onStopped | Called when the player is stopping | ||
AdSkipped onSkip | Called when an ad is skipped | ||
AdClosed onClose | Called when the player is closing | ||
AdVolumeChange onUnmute onMute | Called when the ad volume is changed | ||
ContentImpression onContentPlay | Called whenever a content video is starting to play | ||
ContentComplete onContentPlay100 | Called whenever the content video is ending | ||
ContentPaused onContentPaused | Called when the content video is paused | ||
ContentPlaying onContentPlaying | Called when the content video resume playing | ||
ContentClick onContentClick | Called when the content video is clicked | ||
Inventory onInventory | Called when the player is initialized | ||
InventoryRequest onInventoryRequest | Called every time the player starts a waterfall run | ||
AdViewableImpression | Called on viewable impression event - when ad is viewable for at least 2 consecutive sconds |
...
Code Block | ||
---|---|---|
| ||
player.on("AdError", function(res){ if(res && res.errorlimit) { //Player stopped console.log(res.reason) } }); |
The player also provides the reason for stopping in reason field
Possible values are:
Player mode:
errorlimit: Player reached max number of waterfall runs without impression
emptywf: The waterfall is empty
maxrun: The player reached adConfig.maxrun waterfall runs
maximp: The player reached adConfig.maximp impressions
Vpaid mode:
maxpagereq: The vpaid reached the maximum number of ad requests on the page and cannot run again
maxpagerun: The vpaid reached the maximum number of runs on the page
Player Templates
The player support advanced templates such as In Article, Floating, Sticky and many customizations.
...