Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

  • request

  • bid

  • error (no bid)

  • all other vast events such as pause, resume, etc…

vpaid progress events:

  • initAd

  • initAdError

  • initAdTimeout

  • AdLoaded

  • startAd

  • startAdTimeout

  • startAdError

AdImpression

onPlay

Called when there is a video impression.
The AdImpression event pass a parameter with extra data that is used for 3rd party reporting:

Code Block
{
  "asid": "Ad source id",
  "clickThrough": "Ad click url if available",
  "videoUrl": "Url of media file if available",
  "mt": "Media type, vast or vpaid",
  "tagInfo" : {
    "url": "Actual ad source meta data, template of url",
    "bidCpm": Actual bid cpm (prebid, rtb) or floor if vast/platform link,
    "pubCpm": Publisher CPM after rev share,
    "floorCpm": floor price used
    "bidCode": "Bidder code from prebid",
    "vast": Array of vast chain,
    "bidder": bidder name,
    "type": Internal type of ad source
    "provider": Internal platform type
    "ismp": 1 if from marketplace
    "bidData": 
    Extra demand/prebid/vast properties if available such as prebid meta
    Note that bidData params will not alwyas be available as it depends on vast/prebid response
      {
        "adSystem": Ad System from vast 
        "advertiserDomains": List of advertiser domains
        "auctionId": Prebid auction id
        "cpm": Prebid CPM
        "dealId": Deal id
        "meta": Prebid meta data as is if available in bid response
        "vast": Vast object (Internal use)
        "vastAdId": Ad id from vast
        "vastAdvertiserId": Advertiser id from vast
        "vastAdvertiserName": Advertiser name from vast
        "vastCreativeAdId": Vast creative ad id
        "vastCreativeId": Vast creative id
        "vastUniversalAdIds": Vast universal ad ids
        "vastUrl": Vast url 
      }
  }
}

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

...