Skip to content

Latest commit

 

History

History
3102 lines (3089 loc) · 80.9 KB

quick-guide.md

File metadata and controls

3102 lines (3089 loc) · 80.9 KB

VAST Versions Quick Guide

This guide is a quick reference tool for those looking to upgrade to the latest version of VAST or looking to add additional feature support to existing implementations. Deprecated or deleted VAST features are shown using strikethrough.

VAST Versions

  • VAST 2.0
  • VAST 3.0
  • VAST 4.x (currently 4.2)

Quick Guides

VAST Inline Elements and Attributes

Elements Attributes Version Support
VAST 2.0 3.0 4.x
version 2.0 3.0 4.x
   /Error - 3.0 4.x
VAST/Ad 2.0 3.0 4.x
id 2.0 3.0 4.x
sequence - 3.0 4.x
conditionalAd - - 4.x
adType - - 4.x
VAST/Ad/InLine 2.0 3.0 4.x
   /AdSystem 2.0 3.0 4.x
version 2.0 3.0 4.x
   /AdTitle 2.0 3.0 4.x
   /Impression 2.0 3.0 4.x
   /AdServingId - - 4.x
   /Category - - 4.x
authority - - 4.x
   /Description 2.0 3.0 4.x
   /Advertiser - 3.0 4.x
id - - 4.x
   /Pricing - 3.0 4.x
model - 3.0 4.x
currency - 3.0 4.x
   /Survey 2.0 3.0 4.x
type - 3.0 4.x
   /Error 2.0 3.0 4.x
   /Expires - - 4.x
   /ViewableImpression - - 4.x
id - - 4.x
      /Viewable - - 4.x
      /NotViewable - - 4.x
      /ViewUndetermined - - 4.x
   /AdVerifications - - 4.x
      /Verification - - 4.x
vendor - - 4.x
         /JavaScriptResource - - 4.x
apiFramework - - 4.x
browserOptional - - 4.x
         /FlashResource - - 4.x
apiFramework - - 4.x
         /ExecutableResource - - 4.x
apiFramework - - 4.x
language - - 4.x
         /TrackingEvents - - 4.x
            /Tracking - - 4.x
event - - 4.x
         /ViewableImpression - - 4.x
id - - 4.x
         /VerificationParameters - - 4.x
   /Extensions 2.0 3.0 4.x
      /Extension 2.0 3.0 4.x
type 2.0 3.0 4.x
   /Creatives 2.0 3.0 4.x
      /Creative 2.0 3.0 4.x
id 2.0 3.0 4.x
sequence 2.0 3.0 4.x
adId 2.0 3.0 4.x
apiFramework - - 4.x
         /UniversalAdId - - 4.x
idRegistry - - 4.x
idValue - - 4.x
         /CreativeExtensions - 3.0 4.x
            /CreativeExtension - 3.0 4.x
type - 3.0 4.x
         /Linear 2.0 3.0 4.x
skipoffset - 3.0 4.x
            /Duration 2.0 3.0 4.x
            /AdParameters - 3.0 4.x
xmlEncoded - 3.0 4.x
            /MediaFiles 2.0 3.0 4.x
               /Mezzanine - - 4.x
delivery - - 4.x
type - - 4.x
width - - 4.x
height - - 4.x
codec - - 4.x
id - - 4.x
fileSize - - 4.x
mediaType - - 4.x
               /MediaFile 2.0 3.0 4.x
id 2.0 3.0 4.x
delivery 2.0 3.0 4.x
type 2.0 3.0 4.x
bitrate 2.0 3.0 4.x
minBitrate - 3.0 4.x
maxBitrate - 3.0 4.x
width 2.0 3.0 4.x
height 2.0 3.0 4.x
scalable 2.0 3.0 4.x
maintainAspectRatio 2.0 3.0 4.x
codec - 3.0 4.x
apiFramework 2.0 3.0 4.x
fileSize - - 4.x
mediaType - - 4.x
               /InteractiveCreativeFile - - 4.x
type - - 4.x
apiFramework - - 4.x
variableDuration - - 4.x
               /ClosedCaptionFiles - - 4.x
                  /ClosedCaptionFile - - 4.x
type - - 4.x
language - - 4.x
            /VideoClicks 2.0 3.0 4.x
               /ClickThrough 2.0 3.0 4.x
id 3.0 4.x
               /ClickTracking 2.0 3.0 4.x
id 3.0 4.x
               /CustomClick 2.0 3.0 4.x
id 3.0 4.x
            /TrackingEvents 2.0 3.0 4.x
               /Tracking 2.0 3.0 4.x
event 2.0 3.0 4.x
offset - 3.0 4.x
            /Icons - 3.0 4.x
               /Icon - 3.0 4.x
program - 3.0 4.x
width - 3.0 4.x
height - 3.0 4.x
xPosition - 3.0 4.x
yPosition - 3.0 4.x
duration - 3.0 4.x
offset - 3.0 4.x
apiFramework - 3.0 4.x
pxratio - - 4.x
                  /StaticResource - 3.0 4.x
creativeType - 3.0 4.x
                  /IFrameResource - 3.0 4.x
                  /HTMLResource - 3.0 4.x
                  /IconClicks - 3.0 4.x
                     /IconClickThrough - 3.0 4.x
                     /IconClickTracking - 3.0 4.x
id - 3.0 4.x
                     /IconClickFallbackImages - - 4.x
                        /IconClickFallbackImage - - 4.x
                           /AltText - - 4.x
                           /StaticResource - - 4.x
                  /IconViewTracking - 3.0 4.x
         /NonLinearAds 2.0 3.0 4.x
            /NonLinear 2.0 3.0 4.x
id 2.0 3.0 4.x
width 2.0 3.0 4.x
height 2.0 3.0 4.x
expandedWidth 2.0 3.0 4.x
expandedHeight 2.0 3.0 4.x
scalable 2.0 3.0 4.x
maintainAspectRatio 2.0 3.0 4.x
minSuggestedDuration 2.0 3.0 4.x
apiFramework 2.0 3.0 4.x
               /NonLinearClickThrough 2.0 3.0 4.x
               /NonLinearClickTracking - 3.0 4.x
id - 3.0 4.x
            /TrackingEvents 2.0 3.0 4.x
               /Tracking 2.0 3.0 4.x
event 2.0 3.0 4.x
            /AdParameters 2.0 - -
xmlEncoded 2.0 - -
         /CompanionAds 2.0 3.0 4.x
required 2.0 3.0 4.x
            /Companion 2.0 3.0 4.x
id 2.0 3.0 4.x
width 2.0 3.0 4.x
height 2.0 3.0 4.x
assetWidth - 3.0 4.x
assetHeight - 3.0 4.x
expandedWidth 2.0 3.0 4.x
expandedHeight 2.0 3.0 4.x
apiFramework 2.0 3.0 4.x
adSlotId - 3.0 4.x
pxratio - - 4.x
renderingMode - - 4.x
               /StaticResource 2.0 3.0 4.x
creativeType 2.0 3.0 4.x
               /IFrameResource 2.0 3.0 4.x
               /HTMLResource 2.0 3.0 4.x
               /AdParameters 2.0 3.0 4.x
xmlEncoded - 3.0 4.x
               /AltText 2.0 3.0 4.x
               /CompanionClickThrough 2.0 3.0 4.x
               /CompanionClickTracking - 3.0 4.x
id - 3.0 4.x
               /TrackingEvents 2.0 3.0 4.x
                  /Tracking 2.0 3.0 4.x
event 2.0 3.0 4.x

VAST Wrapper Elements and Attributes

Elements Attributes Version Support
VAST/Ad/Wrapper 2.0 3.0 4.x
followAdditionalWrappers - - 4.x
allowMultipleAds - - 4.x
fallbackOnNoAd - - 4.x
   /Impression 2.0 3.0 4.x
id 2.0 3.0 4.x
   /VASTAdTagURI 2.0 3.0 4.x
   /AdSystem 2.0 3.0 4.x
version 2.0 3.0 4.x
   /Pricing - - 4.x
model - - 4.x
currency - - 4.x
   /Error 2.0 3.0 4.x
   /ViewableImpression - - 4.x
id - - 4.x
      /Viewable - - 4.x
      /NotViewable - - 4.x
      /ViewUndetermined - - 4.x
   /AdVerifications - - 4.x
      /Verification - - 4.x
vendor - - 4.x
         /JavaScriptResource - - 4.x
apiFramework - - 4.x
browserOptional - - 4.x
         /ExecutableResource - - 4.x
apiFramework - - 4.x
language - - 4.x
         /TrackingEvents - - 4.x
            /Tracking - - 4.x
event - - 4.x
         /VerificationParameters - - 4.x
         /BlockedAdCategories - - 4.x
         /ViewableImpression - - 4.x
id - - 4.x
   /Extensions 2.0 3.0 4.x
      /Extension 2.0 3.0 4.x
type 2.0 3.0 4.x
   /Creatives 2.0 3.0 4.x
      /Creative 2.0 3.0 4.x
id 2.0 3.0 4.x
sequence 2.0 3.0 4.x
adId 2.0 3.0 4.x
         /Linear 2.0 3.0 4.x
            /TrackingEvents 2.0 3.0 4.x
               /Tracking 2.0 3.0 4.x
event 2.0 3.0 4.x
offset - 3.0 4.x
            /VideoClicks 2.0 3.0 4.x
               /ClickThrough - - 4.x
id - - 4.x
               /ClickTracking 2.0 3.0 4.x
id 2.0 3.0 4.x
               /CustomClick 2.0 3.0 4.x
id 2.0 3.0 4.x
            /Icons - 3.0 4.x
               /Icon - 3.0 4.x
program - 3.0 4.x
width - 3.0 4.x
height - 3.0 4.x
xPosition - 3.0 4.x
yPosition - 3.0 4.x
duration - 3.0 4.x
offset - 3.0 4.x
apiFramework - 3.0 4.x
pxratio - - 4.x
                  /StaticResource - 3.0 4.x
creativeType - 3.0 4.x
                  /IFrameResource - 3.0 4.x
                  /HTMLResource - 3.0 4.x
                  /IconClicks - 3.0 4.x
                     /IconClickThrough - 3.0 4.x
                     /IconClickTracking - 3.0 4.x
id - - 4.x
                     /IconClickFallbackImages - - 4.x
                        /IconClickFallbackImage - - 4.x
                           /AltText - - 4.x
                           /StaticResource - - 4.x
                  /IconViewTracking - 3.0 4.x
            /InteractiveCreativeFile - - 4.x
type - - 4.x
apiFramework - - 4.x
variableDuration - - 4.x
         /NonLinearAds 2.0 3.0 4.x
            /NonLinear 2.0 3.0 4.x
id 2.0 3.0 4.x
width 2.0 3.0 4.x
height 2.0 3.0 4.x
expandedWidth 2.0 3.0 4.x
expandedHeight 2.0 3.0 4.x
scalable 2.0 3.0 4.x
maintainAspectRatio 2.0 3.0 4.x
minSuggestedDuration 2.0 3.0 4.x
apiFramework 2.0 3.0 4.x
               /NonLinearClickThrough 2.0 3.0 4.x
               /NonLinearClickTracking - 3.0 4.x
            /TrackingEvents 2.0 3.0 4.x
               /Tracking 2.0 3.0 4.x
event 2.0 3.0 4.x
         /CompanionAds 2.0 3.0 4.x
required - 3.0 4.x
            /Companion 2.0 3.0 4.x
id 2.0 3.0 4.x
width 2.0 3.0 4.x
height 2.0 3.0 4.x
assetWidth - 3.0 4.x
assetHeight - 3.0 4.x
expandedWidth 2.0 3.0 4.x
expandedHeight 2.0 3.0 4.x
apiFramework 2.0 3.0 4.x
adSlotId - 3.0 4.x
pxratio - - 4.x
renderingMode - - 4.x
               /StaticResource 2.0 3.0 4.x
creativeType 2.0 3.0 4.x
               /IFrameResource 2.0 3.0 4.x
               /HTMLResource 2.0 3.0 4.x
               /AdParameters 2.0 3.0 4.x
xmlEncoded - 3.0 4.x
               /AltText 2.0 3.0 4.x
               /CompanionClickThrough 2.0 3.0 4.x
               /CompanionClickTracking - 3.0 4.x
id - 3.0 4.x
               /TrackingEvents 2.0 3.0 4.x
                  /Tracking 2.0 3.0 4.x
event 2.0 3.0 4.x

VAST Error Codes

VAST Error Codes - Version Support
100 - 3.0 4.x
101 - 3.0 4.x
102 - 3.0 4.x
200 - 3.0 4.x
201 - 3.0 4.x
202 - 3.0 4.x
203 - 3.0 4.x
204 - - 4.x
205 - - 4.x
206 - - 4.x
300 - 3.0 4.x
301 - 3.0 4.x
302 - 3.0 4.x
303 - 3.0 4.x
304 - - 4.x
400 - 3.0 4.x
401 - 3.0 4.x
402 - 3.0 4.x
403 - 3.0 4.x
405 - 3.0 4.x
406 - - 4.x
407 - - 4.x
408 - - 4.x
409 - - 4.x
410 - - 4.x
411 - - 4.x
500 - 3.0 4.x
501 - 3.0 4.x
502 - 3.0 4.x
503 - 3.0 4.x
600 - 3.0 4.x
601 - 3.0 4.x
602 - 3.0 4.x
603 - 3.0 4.x
604 - 3.0 4.x
900 - 3.0 4.x
901 - 3.0 4.x
902 - - 4.x

VAST Macros

VAST Macros Macro Type Version Support
[TIMESTAMP] Generic Macros - - 4.x
[CACHEBUSTING] Generic Macros - 3.0 4.x
[CONTENTPLAYHEAD] Ad Break Info - 3.0 4.x
[MEDIAPLAYHEAD] Ad Break Info - - 4.x
[BREAKPOSITION] Ad Break Info - - 4.x
[BLOCKEDADCATEGORIES] Ad Break Info - - 4.x
[ADCATEGORIES] Ad Break Info - - 4.x
[ADCOUNT] Ad Break Info - - 4.x
[TRANSACTIONID] Ad Break Info - - 4.x
[PLACEMENTTYPE] Ad Break Info - - 4.x
[ADTYPE] Ad Break Info - - 4.x
[UNIVERSALADID] Ad Break Info - - 4.x
[BREAKMAXDURATION] Ad Break Info - - 4.x
[BREAKMINDURATION] Ad Break Info - - 4.x
[BREAKMAXADS] Ad Break Info - - 4.x
[BREAKMINADLENGTH] Ad Break Info - - 4.x
[BREAKMAXADLENGTH] Ad Break Info - - 4.x
[IFA] Client Info - - 4.x
[IFATYPE] Client Info - - 4.x
[CLIENTUA] Client Info - - 4.x
[SERVERUA] Client Info - - 4.x
[DEVICEUA] Client Info - - 4.x
[SERVERSIDE] Client Info - - 4.x
[DEVICEIP] Client Info - - 4.x
[LATLONG] Client Info - - 4.x
[DOMAIN] Publisher Info - - 4.x
[PAGEURL] Publisher Info - - 4.x
[APPBUNDLE] Publisher Info - - 4.x
[VASTVERSIONS] Capabilities Info - - 4.x
[APIFRAMEWORKS] Capabilities Info - - 4.x
[EXTENSIONS] Capabilities Info - - 4.x
[VERIFICATIONVENDORS] Capabilities Info - - 4.x
[OMIDPARTNER] Capabilities Info - - 4.x
[MEDIAMIME] Capabilities Info - - 4.x
[PLAYERCAPABILITIES] Capabilities Info - - 4.x
[CLICKTYPE] Capabilities Info - - 4.x
[PLAYERSTATE] Player State Info - - 4.x
[INVENTORYSTATE] Player State Info - - 4.x
[PLAYERSIZE] Player State Info - - 4.x
[ADPLAYHEAD] Player State Info - - 4.x
[ASSETURI] Player State Info - 3.0 4.x
[CONTENTID] Player State Info - - 4.x
[CONTENTURI] Player State Info - - 4.x
[PODSEQUENCE] Player State Info - - 4.x
[ADSERVINGID] Player State Info - - 4.x
[CLICKPOS] Click Info - - 4.x
[ERRORCODE] Error Info - 3.0 4.x
[REASON] Verificaion Info - - 4.x
[LIMITADTRACKING] Regulation Info - - 4.x
[REGULATIONS] Regulation Info - - 4.x
[GDPRCONSENT] Regulation Info - - 4.x

VAST Tracking Events

VAST Tracking Events Metric Type Version Support
mute Player Operation 2.0 3.0 4.x
unmute Player Operation 2.0 3.0 4.x
pause Player Operation 2.0 3.0 4.x
resume Player Operation 2.0 3.0 4.x
rewind Player Operation 2.0 3.0 4.x
skip Player Operation - 3.0 4.x
fullscreen Player Operation 2.0 3.0 -
exitFullscreen Player Operation - 3.0 -
playerExpand Player Operation - - 4.x
playerCollapse Player Operation - - 4.x
notUsed Player Operation - - 4.x
loaded Linear Ad - - 4.x
start Linear Ad 2.0 3.0 4.x
firstQuartile Linear Ad 2.0 3.0 4.x
midpoint Linear Ad 2.0 3.0 4.x
thirdQuartile Linear Ad 2.0 3.0 4.x
complete Linear Ad 2.0 3.0 4.x
otherAdInteraction Linear Ad - - 4.x
progress Linear Ad - 3.0 4.x
closeLinear Linear Ad - 3.0 4.x
acceptInvitationLinear Linear Ad - 3.0 4.x
timeSpentViewing Linear Ad - - 4.x
creativeView NonLinear Ad 2.0 3.0 4.x
acceptInvitation NonLinear Ad 2.0 3.0 4.x
expand NonLinear Ad 2.0 3.0 -
collapse NonLinear Ad 2.0 3.0 -
adExpand NonLinear Ad - - 4.x
adCollapse NonLinear Ad - - 4.x
minimize NonLinear Ad - - 4.x
close NonLinear Ad 2.0 3.0 4.x
overlayViewDuration NonLinear Ad - - 4.x
otherAdInteraction NonLinear Ad - - 4.x
creativeView Companion Ad 2.0 3.0 4.x
interactiveStart Interactive Ad - - 4.x
verificationNotExecuted Verification - - 4.x