diff --git a/vast-versions-quick-guide.md b/vast-versions-quick-guide.md new file mode 100644 index 0000000..9b4eeb8 --- /dev/null +++ b/vast-versions-quick-guide.md @@ -0,0 +1,3102 @@ +# 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](#vast-inline-elements-and-attributes) +* [VAST Wrapper Elements and Attributes](#vast-wrapper-elements-and-attributes) +* [VAST Error Codes](#vast-error-codes) +* [VAST Macros](#vast-macros) +* [VAST Tracking Events](#vast-tracking-events) + +## VAST Inline Elements and Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ElementsAttributesVersion Support
VAST2.03.04.x
version2.03.04.x
   /Error-3.04.x
VAST/Ad2.03.04.x
id2.03.04.x
sequence-3.04.x
conditionalAd--4.x
adType--4.x
VAST/Ad/InLine2.03.04.x
   /AdSystem2.03.04.x
version2.03.04.x
   /AdTitle2.03.04.x
   /Impression2.03.04.x
   /AdServingId--4.x
   /Category--4.x
authority--4.x
   /Description2.03.04.x
   /Advertiser-3.04.x
id--4.x
   /Pricing-3.04.x
model-3.04.x
currency-3.04.x
   /Survey2.03.04.x
type-3.04.x
   /Error2.03.04.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
   /Extensions2.03.04.x
      /Extension2.03.04.x
type2.03.04.x
   /Creatives2.03.04.x
      /Creative2.03.04.x
id2.03.04.x
sequence2.03.04.x
adId2.03.04.x
apiFramework--4.x
         /UniversalAdId--4.x
idRegistry--4.x
idValue--4.x
         /CreativeExtensions-3.04.x
            /CreativeExtension-3.04.x
type-3.04.x
         /Linear2.03.04.x
skipoffset-3.04.x
            /Duration2.03.04.x
            /AdParameters-3.04.x
xmlEncoded-3.04.x
            /MediaFiles2.03.04.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
               /MediaFile2.03.04.x
id2.03.04.x
delivery2.03.04.x
type2.03.04.x
bitrate2.03.04.x
minBitrate-3.04.x
maxBitrate-3.04.x
width2.03.04.x
height2.03.04.x
scalable2.03.04.x
maintainAspectRatio2.03.04.x
codec-3.04.x
apiFramework2.03.04.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
            /VideoClicks2.03.04.x
               /ClickThrough2.03.04.x
id3.04.x
               /ClickTracking2.03.04.x
id3.04.x
               /CustomClick2.03.04.x
id3.04.x
            /TrackingEvents2.03.04.x
               /Tracking2.03.04.x
event2.03.04.x
offset-3.04.x
            /Icons-3.04.x
               /Icon-3.04.x
program-3.04.x
width-3.04.x
height-3.04.x
xPosition-3.04.x
yPosition-3.04.x
duration-3.04.x
offset-3.04.x
apiFramework-3.04.x
pxratio--4.x
                  /StaticResource-3.04.x
creativeType-3.04.x
                  /IFrameResource-3.04.x
                  /HTMLResource-3.04.x
                  /IconClicks-3.04.x
                     /IconClickThrough-3.04.x
                     /IconClickTracking-3.04.x
id-3.04.x
                     /IconClickFallbackImages--4.x
                        /IconClickFallbackImage--4.x
                           /AltText--4.x
                           /StaticResource--4.x
                  /IconViewTracking-3.04.x
         /NonLinearAds2.03.04.x
            /NonLinear2.03.04.x
id2.03.04.x
width2.03.04.x
height2.03.04.x
expandedWidth2.03.04.x
expandedHeight2.03.04.x
scalable2.03.04.x
maintainAspectRatio2.03.04.x
minSuggestedDuration2.03.04.x
apiFramework2.03.04.x
               /NonLinearClickThrough2.03.04.x
               /NonLinearClickTracking-3.04.x
id-3.04.x
            /TrackingEvents2.03.04.x
               /Tracking2.03.04.x
event2.03.04.x
            /AdParameters2.0--
xmlEncoded2.0--
         /CompanionAds2.03.04.x
required2.03.04.x
            /Companion2.03.04.x
id2.03.04.x
width2.03.04.x
height2.03.04.x
assetWidth-3.04.x
assetHeight-3.04.x
expandedWidth2.03.04.x
expandedHeight2.03.04.x
apiFramework2.03.04.x
adSlotId-3.04.x
pxratio--4.x
renderingMode--4.x
               /StaticResource2.03.04.x
creativeType2.03.04.x
               /IFrameResource2.03.04.x
               /HTMLResource2.03.04.x
               /AdParameters2.03.04.x
xmlEncoded-3.04.x
               /AltText2.03.04.x
               /CompanionClickThrough2.03.04.x
               /CompanionClickTracking-3.04.x
id-3.04.x
               /TrackingEvents2.03.04.x
                  /Tracking2.03.04.x
event2.03.04.x
+ +## VAST Wrapper Elements and Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ElementsAttributesVersion Support
VAST/Ad/Wrapper2.03.04.x
followAdditionalWrappers--4.x
allowMultipleAds--4.x
fallbackOnNoAd--4.x
   /Impression2.03.04.x
id2.03.04.x
   /VASTAdTagURI2.03.04.x
   /AdSystem2.03.04.x
version2.03.04.x
   /Pricing--4.x
model--4.x
currency--4.x
   /Error2.03.04.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
   /Extensions2.03.04.x
      /Extension2.03.04.x
type2.03.04.x
   /Creatives2.03.04.x
      /Creative2.03.04.x
id2.03.04.x
sequence2.03.04.x
adId2.03.04.x
         /Linear2.03.04.x
            /TrackingEvents2.03.04.x
               /Tracking2.03.04.x
event2.03.04.x
offset-3.04.x
            /VideoClicks2.03.04.x
               /ClickThrough--4.x
id--4.x
               /ClickTracking2.03.04.x
id2.03.04.x
               /CustomClick2.03.04.x
id2.03.04.x
            /Icons-3.04.x
               /Icon-3.04.x
program-3.04.x
width-3.04.x
height-3.04.x
xPosition-3.04.x
yPosition-3.04.x
duration-3.04.x
offset-3.04.x
apiFramework-3.04.x
pxratio--4.x
                  /StaticResource-3.04.x
creativeType-3.04.x
                  /IFrameResource-3.04.x
                  /HTMLResource-3.04.x
                  /IconClicks-3.04.x
                     /IconClickThrough-3.04.x
                     /IconClickTracking-3.04.x
id--4.x
                     /IconClickFallbackImages--4.x
                        /IconClickFallbackImage--4.x
                           /AltText--4.x
                           /StaticResource--4.x
                  /IconViewTracking-3.04.x
            /InteractiveCreativeFile--4.x
type--4.x
apiFramework--4.x
variableDuration--4.x
         /NonLinearAds2.03.04.x
            /NonLinear2.03.04.x
id2.03.04.x
width2.03.04.x
height2.03.04.x
expandedWidth2.03.04.x
expandedHeight2.03.04.x
scalable2.03.04.x
maintainAspectRatio2.03.04.x
minSuggestedDuration2.03.04.x
apiFramework2.03.04.x
               /NonLinearClickThrough2.03.04.x
               /NonLinearClickTracking-3.04.x
            /TrackingEvents2.03.04.x
               /Tracking2.03.04.x
event2.03.04.x
         /CompanionAds2.03.04.x
required-3.04.x
            /Companion2.03.04.x
id2.03.04.x
width2.03.04.x
height2.03.04.x
assetWidth-3.04.x
assetHeight-3.04.x
expandedWidth2.03.04.x
expandedHeight2.03.04.x
apiFramework2.03.04.x
adSlotId-3.04.x
pxratio--4.x
renderingMode--4.x
               /StaticResource2.03.04.x
creativeType2.03.04.x
               /IFrameResource2.03.04.x
               /HTMLResource2.03.04.x
               /AdParameters2.03.04.x
xmlEncoded-3.04.x
               /AltText2.03.04.x
               /CompanionClickThrough2.03.04.x
               /CompanionClickTracking-3.04.x
id-3.04.x
               /TrackingEvents2.03.04.x
                  /Tracking2.03.04.x
event2.03.04.x
+ +## VAST Error Codes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VAST Error Codes-Version Support
100-3.04.x
101-3.04.x
102-3.04.x
200-3.04.x
201-3.04.x
202-3.04.x
203-3.04.x
204--4.x
205--4.x
206--4.x
300-3.04.x
301-3.04.x
302-3.04.x
303-3.04.x
304--4.x
400-3.04.x
401-3.04.x
402-3.04.x
403-3.04.x
405-3.04.x
406--4.x
407--4.x
408--4.x
409--4.x
410--4.x
411--4.x
500-3.04.x
501-3.04.x
502-3.04.x
503-3.04.x
600-3.04.x
601-3.04.x
602-3.04.x
603-3.04.x
604-3.04.x
900-3.04.x
901-3.04.x
902--4.x
+ +## VAST Macros + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VAST MacrosMacro TypeVersion Support
[TIMESTAMP]Generic Macros--4.x
[CACHEBUSTING]Generic Macros-3.04.x
[CONTENTPLAYHEAD]Ad Break Info-3.04.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.04.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.04.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 EventsMetric TypeVersion Support
mutePlayer Operation2.03.04.x
unmutePlayer Operation2.03.04.x
pausePlayer Operation2.03.04.x
resumePlayer Operation2.03.04.x
rewindPlayer Operation2.03.04.x
skipPlayer Operation-3.04.x
fullscreenPlayer Operation2.03.0-
exitFullscreenPlayer Operation-3.0-
playerExpandPlayer Operation--4.x
playerCollapsePlayer Operation--4.x
notUsedPlayer Operation--4.x
loadedLinear Ad--4.x
startLinear Ad2.03.04.x
firstQuartileLinear Ad2.03.04.x
midpointLinear Ad2.03.04.x
thirdQuartileLinear Ad2.03.04.x
completeLinear Ad2.03.04.x
otherAdInteractionLinear Ad--4.x
progressLinear Ad-3.04.x
closeLinearLinear Ad-3.04.x
acceptInvitationLinearLinear Ad-3.04.x
timeSpentViewingLinear Ad--4.x
creativeViewNonLinear Ad2.03.04.x
acceptInvitationNonLinear Ad2.03.04.x
expandNonLinear Ad2.03.0-
collapseNonLinear Ad2.03.0-
adExpandNonLinear Ad--4.x
adCollapseNonLinear Ad--4.x
minimizeNonLinear Ad--4.x
closeNonLinear Ad2.03.04.x
overlayViewDurationNonLinear Ad--4.x
otherAdInteractionNonLinear Ad--4.x
creativeViewCompanion Ad2.03.04.x
interactiveStartInteractive Ad--4.x
verificationNotExecutedVerification--4.x