{ "macros": [ { "id": 1, "name": "TIMESTAMP", "categoryname": "Generic Macros", "categoryindex": 2, "datatype": "string", "type": "string", "introversion": "4.0", "support": "Required", "contexts": "All tracking pixels,VAST request URIs", "format": "{YYYY-MM-DD}T{HH:MM:SS}.{mmm}{+/-}{ZONEOFFSET}", "description": "The date and time at which the URI using this macro is accessed. Used wherever a time stamp is needed, the macro is replaced with the date and time using the formatting conventions of ISO 8601.\nTo add milliseconds, use the convention .mmm at the end of the time provided and before any time zone indicator.", "descriptionformatted": "The date and time at which the URI using this macro is accessed. Used wherever a time stamp is needed, the macro is replaced with the date and time using the formatting conventions of ISO 8601.

To add milliseconds, use the convention .mmm at the end of the time provided and before any time zone indicator.

", "example": "January 17, 2016 at 8:15:07 and 127 milliseconds, Eastern Time would be formatted as follows:
Unencoded: 2016-01-17T8:15:07.127-05
Encoded: 2016-01-17T8%3A15%3A07.127-05" }, { "id": 2, "name": "CACHEBUSTING", "categoryname": "Generic Macros", "categoryindex": 2, "datatype": "integer", "type": "integer", "introversion": "3.0", "support": "Required", "contexts": "All tracking pixels,VAST request URIs", "description": "Random 8-digit integer.", "descriptionformatted": "Random 8-digit integer.", "example": "12345678" }, { "id": 3, "name": "CONTENTPLAYHEAD", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "string", "type": "timecode", "introversion": "3.0", "support": "Deprecated in VAST 4.1, replaced by [ADPLAYHEAD] and [MEDIAPLAYHEAD]", "contexts": "All tracking pixels,VAST request URIs", "format": "{HH:MM:SS.mmm}", "description": "The current time offset of the video or audio content.", "descriptionformatted": "The current time offset of the video or audio content.", "example": "Unencoded: 00:05:21.123
Encoded: 00%3A05%3A21.123" }, { "id": 4, "name": "MEDIAPLAYHEAD", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "string", "type": "timecode", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "{HH:MM:SS.mmm}", "description": "Playhead position of the video or audio content (NOT the ad creative). \nNot relevant for out-stream ads.", "descriptionformatted": "Playhead position of the video or audio content (NOT the ad creative). Not relevant for out-stream ads.", "example": "Unencoded: 00:05:21.123
Encoded: 00%3A05%3A21.123" }, { "id": 5, "name": "BREAKPOSITION", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:BREAKPOSITION_values_worksheet", "description": "Indicates the position of the ad break within the underlying video/audio content that the ad is playing within.", "descriptionformatted": "Indicates the position of the ad break within the underlying video/audio content that the ad is playing in.", "example": "2" }, { "id": 6, "name": "BLOCKEDADCATEGORIES", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "format": "IAB{N}-{N}", "description": "List of blocked ad categories. Encoded with IABN-N values as specified in the \"Content Categories\" list of AdCOM 1.0.\nValues must be taken from the BlockedCategory element (3.19.2) in Wrapper ad elements.", "descriptionformatted": "List of blocked ad categories. Encoded with IABN-N values as specified in the \"Content Categories\" list of AdCOM 1.0.
Values must be taken from the BlockedCategory element (3.19.2) in Wrapper ad elements.", "example": "IAB1-6,IAB1-7" }, { "id": 7, "name": "ADCATEGORIES", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "format": "IAB{N}-{N}", "description": "List of desired ad categories. Encoded with IABN-N values as specified in the \"Content Categories\" list of AdCOM 1.0.", "descriptionformatted": "List of desired ad categories. Encoded with IABN-N values as specified in the \"Content Categories\" list of AdCOM 1.0.", "example": "IAB1-6,IAB1-7" }, { "id": 8, "name": "ADCOUNT", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "For VAST requests: the number of ads expected by the player\nFor tracking pixels: the number of ads played within the current chain or tree of VASTs, including the executing one. That is, this value starts at 1 and increments for each video played, whether it was pulled from a Pod, buffet, nested Pod, etc. In standard non-Pod VAST responses with a single ad, this value is always 1.", "descriptionformatted": "For VAST requests: the number of ads expected by the player

For tracking pixels: the number of ads played within the current chain or tree of VASTs, including the executing one. That is, this value starts at 1 and increments for each video played, whether it was pulled from a Pod, buffet, nested Pod, etc. In standard non-Pod VAST responses with a single ad, this value is always 1.

", "example": "2" }, { "id": 9, "name": "TRANSACTIONID", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "string", "type": "UUID", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "UUID", "description": "An identifier used to correlate a chain of ad requests from the origination (supply) end. This ID is generated by the initiating player and subsequent ad requests along the chain must pass the same ID along. This ID must be a UUID. Note that this is unique to the initial request, even if there are multiple ads in the response, as in VMAP and VAST Ad Pod cases.", "descriptionformatted": "An identifier used to correlate a chain of ad requests from the origination (supply) end. This ID is generated by the initiating player and subsequent ad requests along the chain must pass the same ID along. This ID must be a UUID. Note that this is unique to the initial request, even if there are multiple ads in the response, as in VMAP and VAST Ad Pod cases.", "example": "123e4567-e89b-12d3-a456-426655440000" }, { "id": 10, "name": "PLACEMENTTYPE", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Indicates the type of ad placement. Refer to the Placement Subtypes - Video list in AdCOM.", "descriptionformatted": "Indicates the type of ad placement. Refer to the Placement Subtypes - Video list in AdCOM.", "example": "1" }, { "id": 11, "name": "ADTYPE", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Indicates whether the ad’s intended use case was video, audio, or hybrid, as defined in the adType attribute of the VAST element.", "descriptionformatted": "Indicates whether the ad’s intended use case was video, audio, or hybrid, as defined in the adType attribute of the VAST element.", "example": "video" }, { "id": 12, "name": "UNIVERSALADID", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels", "format": "{registryID}{space}{idvalue}", "description": "Indicates the creative, using UniversalAdId values described in section 3.7.1.\nFormat: registryID idvalue - with a space separating registryID and value.\nMultiple UniversalAdIds can be supported with a comma-separating them.", "descriptionformatted": "Indicates the creative, using UniversalAdId values described in section 3.7.1.", "example": "Unencoded: ad-id.org CNPA0484000H
Encoded: ad-id.org%20CNPA0484000H" }, { "id": 13, "name": "BREAKMAXDURATION", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.2", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Indicates the maximum length allowed for the ad break in seconds.", "descriptionformatted": "Indicates the maximum length allowed for the ad break in seconds.", "example": "30 - 30 seconds max total length allowed in the break." }, { "id": 14, "name": "BREAKMAXADS", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.2", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Indicates the maximum number of ads allowed in the ad break.", "descriptionformatted": "Indicates the maximum number of ads allowed in the ad break.", "example": "2 - two ads max in the break." }, { "id": 15, "name": "BREAKMINADLENGTH", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.2", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Indicates the minimum length allowed for any individual ad in the ad break in seconds.", "descriptionformatted": "Indicates the minimum length allowed for any individual ad in the ad break in seconds.", "example": "5 - five seconds is the min duration of any ad allowed in the break." }, { "id": 16, "name": "BREAKMAXADLENGTH", "categoryname": "Ad Break Info", "categoryindex": 3, "datatype": "integer", "type": "integer", "introversion": "4.2", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Indicates the maximum length allowed for any individual ad in the ad break in seconds.", "descriptionformatted": "Indicates the maximum length allowed for any individual ad in the ad break in seconds.", "example": "15 - fifteen seconds is the maximum duration of any ad allowed in the break." }, { "id": 17, "name": "IFA", "categoryname": "Client Info", "categoryindex": 4, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "UUID", "description": "A resettable advertising ID from a device-specific advertising ID scheme, such as Apple’s ID for Advertisers or Android’s Advertising ID in UUID format or based on the IAB Tech Lab’s Guidelines for IFA on OTT platforms.", "descriptionformatted": "A resettable advertising ID from a device-specific advertising ID scheme, such as Apple’s ID for Advertisers or Android’s Advertising ID in UUID format or based on the IAB Tech Lab’s Guidelines for IFA on OTT platforms.", "example": "123e4567-e89b-12d3-a456-426655440000" }, { "id": 18, "name": "IFATYPE", "categoryname": "Client Info", "categoryindex": 4, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "String value indicating the type of IFA included in the [IFA] macro. More details in the IAB Tech Lab’s Guidelines for IFA on OTT platforms.", "descriptionformatted": "String value indicating the type of IFA included in the [IFA] macro. More details in the IAB Tech Lab’s Guidelines for IFA on OTT platforms.", "example": "1rida" }, { "id": 19, "name": "CLIENTUA", "categoryname": "Client Info", "categoryindex": 4, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "{player name}/{player version}{space}{plugin name}/{plugin version}", "description": "An identifier of the player and VAST client used. This will allow creative providers to identify the client code used to process and render video creatives.\nIf player name is not available, use \"unknown\".", "descriptionformatted": "An identifier of the player and VAST client used. This will allow creative providers to identify the client code used to process and render video creatives.
If player name is not available, use \"unknown\".", "example": "Unencoded:MyPlayer/7.1 MyPlayerVastPlugin/1.1.2
Encoded:MyPlayer%2F7.1%20MyPlayerVastPlugin%2F1.1.2

Unencoded:unknown MyPlayerVastPlugin/1.1.2
Encoded:unknown%20MyPlayerVastPlugin%2F1.1.2

" }, { "id": 20, "name": "SERVERUA", "categoryname": "Client Info", "categoryindex": 4, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "{service name}/{version} ({URL to vendor info})", "description": "User-Agent of the server making the request on behalf of a client.\nOnly relevant when another device (server) is making the request on behalf of that client.\n\nThe goal is to allow ad servers to identify who is making the request, so don’t use generic HTTP server names like Apache, but rather identify the company and product or service making the request.", "descriptionformatted": "User-Agent of the server making the request on behalf of a client.

Only relevant when another device (server) is making the request on behalf of that client.

The goal is to allow ad servers to identify who is making the request, so don’t use generic HTTP server names like Apache, but rather identify the company and product or service making the request.

", "example": "Unencoded:MyServer/3.0 (+https://myserver.com/contact)
Encoded:MyServer%2F3.0%20(%2Bhttps%3A%2F%2Fmyserver.com%2Fcontact)

Unencoded:AdsBot-Google (+http://www.google.com/adsbot.html)
Encoded:AdsBot-Google%20(%2Bhttp%3A%2F%2Fwww.google.com%2Fadsbot.html)

" }, { "id": 21, "name": "DEVICEUA", "categoryname": "Client Info", "categoryindex": 4, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "User-Agent of the device that is rendering the ad to the end user.\nOnly relevant when another device (server) is making the request on behalf of that client.", "descriptionformatted": "User-Agent of the device that is rendering the ad to the end user.

Only relevant when another device (server) is making the request on behalf of that client.

", "example": " Unencoded:Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36
Encoded:Mozilla%2F5.0%20(X11%3B%20Linux%20x86_64)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F51.0.2704.103%20Safari%2F537.36" }, { "id": 22, "name": "SERVERSIDE", "categoryname": "Client Info", "categoryindex": 4, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:SERVERSIDE_values_worksheet", "description": "Value indicating if a URL is requested from a client device or a server. This value may be set differently on the request versus tracking URLs, as the request may be made from a server (value of 1 or 2) while tracking URLs may be fired from the client (value of 0).\n\n0 is the default value if macro is missing.", "descriptionformatted": " Value indicating if a URL is requested from a client device or a server. This value may be set differently on the request versus tracking URLs, as the request may be made from a server (value of 1 or 2) while tracking URLs may be fired from the client (value of 0). 0 is the default value if macro is missing.", "example": "1" }, { "id": 23, "name": "DEVICEIP", "categoryname": "Client Info", "categoryindex": 4, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "IP address of the device that is rendering the ad to the end user.\nOnly relevant when another device (server) is making the request on behalf of that client.", "descriptionformatted": "IP address of the device that is rendering the ad to the end user.

Only relevant when another device (server) is making the request on behalf of that client.

", "example": "IPv6 unencoded: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
IPv6 encoded: 2001%3A0db8%3A85a3%3A0000%3A0000%3A8a2e%3A0370%3A7334" }, { "id": 24, "name": "LATLONG", "categoryname": "Client Info", "categoryindex": 4, "datatype": "Array(2)", "type": "Array(2)", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Mobile detected geolocation info of the end user; latitude and longitude separated by a coma.", "descriptionformatted": "Mobile detected geolocation info of the end user; latitude and longitude separated by a coma.", "example": "51.004703,3.754806" }, { "id": 25, "name": "DOMAIN", "categoryname": "Publisher Info", "categoryindex": 5, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Domain of the top level page where the end user will view the ad.", "descriptionformatted": "Domain of the top level page where the end user will view the ad.", "example": "www.mydomain.com" }, { "id": 26, "name": "PAGEURL", "categoryname": "Publisher Info", "categoryindex": 5, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Required if OM for Web is supported, otherwise Optional.", "contexts": "All tracking pixels,VAST request URIs", "description": "The full URL of the top level page where the end user will view the ad. Where required and applicable, but unknown or unavailable, -1 or -2 must be set, as described in 6.1. When required and not applicable (such as in an app), 0 must be set.", "descriptionformatted": "The full URL of the top level page where the end user will view the ad. Where required and applicable, but unknown or unavailable, -1 or -2 must be set, as described in 6.1. When required and not applicable (such as in an app), 0 must be set.", "example": "Unencoded:https://www.mydomain.com/article/page
Encoded:https%3A%2F%2Fwww.mydomain.com%2Farticle%2Fpage" }, { "id": 27, "name": "APPBUNDLE", "categoryname": "Publisher Info", "categoryindex": 5, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Required if OM for App is supported, otherwise Optional.", "contexts": "All tracking pixels,VAST request URIs", "description": "For app ads, a platform-specific application identifier, bundle or package name and should not be an app store ID such as iTunes store ID. Where required and applicable, but unknown or unavailable, -1 or -2 must be set, as described in 6.1. When required and not applicable (such as in an app), 0 must be set.", "descriptionformatted": "For app ads, a platform-specific application identifier, bundle or package name and should not be an app store ID such as iTunes store ID. Where required and applicable, but unknown or unavailable, -1 or -2 must be set, as described in 6.1. When required and not applicable (such as in an app), 0 must be set.", "example": "com.example.myapp" }, { "id": 28, "name": "VASTVERSIONS", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "description": "List of VAST versions supported by the player. Values are defined in the AdCOM 1.0 \"Creative Subtypes\" list. The relevant IDs have been copied here for convenience.\n11 for VAST 4.1\n12 for VAST 4.1 Wrapper", "descriptionformatted": "List of VAST versions supported by the player. Values are defined in the AdCOM 1.0 \"Creative Subtypes\" list. The relevant IDs have been copied here for convenience.

11 for VAST 4.1
12 for VAST 4.1 Wrapper", "example": "2,3,5,6,7,8,11" }, { "id": 29, "name": "APIFRAMEWORKS", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "description": "ist of frameworks supported by the player. Values are defined in the AdCOM 1.0 \"API Frameworks\" list.", "descriptionformatted": "List of frameworks supported by the player. Values are defined in the AdCOM 1.0 \"API Frameworks\" list.", "example": "2,7" }, { "id": 30, "name": "EXTENSIONS", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "description": "List of VAST Extensions type attribute values that the player / client supports. Can be used to indicate support for the OMID AdVerifications extension, proprietary extensions, or future standardized extensions.", "descriptionformatted": "List of VAST Extensions type attribute values that the player / client supports. Can be used to indicate support for the OMID AdVerifications extension, proprietary extensions, or future standardized extensions.", "example": "AdVerifications,extensionA,extensionB" }, { "id": 31, "name": "VERIFICATIONVENDORS", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "description": "List of VAST Verification vendor attribute values that the player / client supports.", "descriptionformatted": "List of VAST Verification vendor attribute values that the player / client supports.", "example": "moat.com-omid,ias.com-omid,doubleverify.com-omid" }, { "id": 32, "name": "OMIDPARTNER", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Required (if OM is supported)", "contexts": "All tracking pixels,VAST request URIs", "format": "{partner name}/{partner version}", "description": "An identifier of the OM SDK integration. This is the same as the “name” and “versionString” parameters of the OMID Partner object. This will allow creative providers to determine if the OM partner integration is acceptable.\nNote - This value is essential for communicating the certification status of the OMID integration. If partner ID is not shared, verification vendors will not be able to properly measure and report on this inventory.\n\nIf partner name is not available, use “unknown”.", "descriptionformatted": "An identifier of the OM SDK integration. This is the same as the “name” and “versionString” parameters of the OMID Partner object. This will allow creative providers to determine if the OM partner integration is acceptable.

Note - This value is essential for communicating the certification status of the OMID integration. If partner ID is not shared, verification vendors will not be able to properly measure and report on this inventory.

If partner name is not available, use “unknown”.

", "example": "Unencoded: MyIntegrationPartner/7.1
Encoded: MyIntegrationPartner%2F7.1" }, { "id": 33, "name": "MEDIAMIME", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "VAST request URIs", "format": "{type}/{subtype}", "description": "List of media MIME types supported by the player.", "descriptionformatted": "List of media MIME types supported by the player.", "example": "Unencoded: video/mp4,application/x-mpegURL
Encoded: video%2Fmp4,application%2Fx-mpegURL" }, { "id": 34, "name": "PLAYERCAPABILITIES", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:PLAYERCAPABILITIES_values_worksheet", "description": "List of values that describe the player capabilities.", "descriptionformatted": "List of values that describe the player capabilities." }, { "id": 35, "name": "CLICKTYPE", "categoryname": "Capabilities Info", "categoryindex": 6, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:PLAYERSTATE_values_worksheet", "description": "Indicates the type of clickthrough supported by the player.\n3 supersedes 2 in the case that there are both a link and a confirmation dialog.", "descriptionformatted": "Indicates the type of clickthrough supported by the player.\n

3 supersedes 2 in the case that there are both a link and a confirmation dialog.

", "example": "2" }, { "id": 36, "name": "PLAYERSTATE", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels", "values": "see:CLICKTYPE_values_worksheet", "description": "List of options indicating the current player state.", "descriptionformatted": "List of options indicating the current player state.", "example": "muted,fullscreen" }, { "id": 37, "name": "INVENTORYSTATE", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:INVENTORYSTATE_values_worksheet", "description": "List of options indicating attributes of the inventory.", "descriptionformatted": "List of options indicating attributes of the inventory.", "example": "autoplayed,fullscreen" }, { "id": 38, "name": "PLAYERSIZE", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "Integer width and height of the player, separated by a coma, measured in pixels (device-independent).", "descriptionformatted": "Integer width and height of the player, separated by a coma, measured in pixels (device-independent).", "example": "640,360" }, { "id": 39, "name": "ADPLAYHEAD", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "string", "type": "timecode", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels", "format": "{HH:MM:SS.mmm}", "description": "Media playhead position.", "descriptionformatted": "Media playhead position.", "example": " Unencoded: 00:00:11.355
Encoded: 00%3A00%3A11.355" }, { "id": 40, "name": "ASSETURI", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "string", "type": "string", "introversion": "3.0", "support": "Optional", "contexts": "All tracking pixels", "description": "The URI of the ad asset currently being played.", "descriptionformatted": "The URI of the ad asset currently being played.", "example": "Unencoded: https://myadserver.com/video.mp4
Encoded: https%3A%2F%2Fmyadserver.com%2Fvideo.mp4" }, { "id": 41, "name": "CONTENTID", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "{registry_id}{space}{id_value}", "description": "The publisher-specific content identifier for the content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads.\nThe format of this field is similar to the [UNIVERSALADID] macro, consisting of a registry identifier and a registry-specific content identifier. If you are not using a public registry, you can use your own domain name as the registry identifier.\n\nIf this macro is provided, the provided content identifier should uniquely define a specific content asset.", "descriptionformatted": "The publisher-specific content identifier for the content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads.

The format of this field is similar to the [UNIVERSALADID] macro, consisting of a registry identifier and a registry-specific content identifier. If you are not using a public registry, you can use your own domain name as the registry identifier.

If this macro is provided, the provided content identifier should uniquely define a specific content asset.

", "example": " Unencoded: my-domain.com my-video-123
Encoded: my-domain.com%20my-video-123" }, { "id": 42, "name": "CONTENTURI", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "The URI of the main media content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads.", "descriptionformatted": "The URI of the main media content asset into which the ad is being loaded or inserted. Only applicable to in-stream ads.", "example": "Unencoded: https://mycontentserver.com/video.mp4
Encoded: https%3A%2F%2Fmycontentserver.com%2Fvideo.mp4" }, { "id": 43, "name": "PODSEQUENCE", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels", "description": "The value of the sequence attribute on the that is currently playing, if one is provided.", "descriptionformatted": "The value of the sequence attribute on the that is currently playing, if one is provided.", "example": "1" }, { "id": 44, "name": "ADSERVINGID", "categoryname": "Player State Info", "categoryindex": 7, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels", "format": "{AD SERVER NAME}-{UUID}", "description": "The value of the for the currently playing ad, as passed from the ad server.", "descriptionformatted": "The value of the for the currently playing ad, as passed from the ad server.", "example": "ServerName-47ed3bac-1768-4b9a-9d0e-0b92422ab066" }, { "id": 45, "name": "CLICKPOS", "categoryname": "Click Info", "categoryindex": 8, "datatype": "Array(2)", "type": "Array(2)", "introversion": "4.1", "support": "Optional", "contexts": "ClickTracking tracking pixels", "description": "Coordinates of the click relative to the area defined by the [PLAYERSIZE] macro, measured in css (device-independent) pixels.", "descriptionformatted": "Coordinates of the click relative to the area defined by the [PLAYERSIZE] macro, measured in css (device-independent) pixels. ", "example": "315,204" }, { "id": 46, "name": "ERRORCODE", "categoryname": "Error Info", "categoryindex": 9, "datatype": "integer", "type": "integer", "introversion": "3.0", "support": "Required", "contexts": "Error tracking pixels", "description": "VAST Error Code. Replaced with one of the error codes listed in section 2.3.6.3 when the associated error occurs; reserved for error tracking URIs.", "descriptionformatted": "VAST Error Code. Replaced with one of the error codes listed in section 2.3.6.3 when the associated error occurs; reserved for error tracking URIs.", "example": "900" }, { "id": 47, "name": "REASON", "categoryname": "Verification Info", "categoryindex": 10, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Required", "contexts": "verificationNotExecuted tracking pixels", "description": "Reason code for not executing verification.", "descriptionformatted": "Reason code for not executing verification.", "example": "1" }, { "id": 48, "name": "LIMITADTRACKING", "categoryname": "Regulation Info", "categoryindex": 11, "datatype": "integer", "type": "integer", "introversion": "4.1", "support": "Required", "contexts": "All tracking pixels,VAST request URIs", "description": "The limit ad tracking setting of a device-specific advertising ID scheme. This value is a boolean, with “1” indicating that a user has opted for limited ad tracking, and “0” indicating that the user has not opted.", "descriptionformatted": "The limit ad tracking setting of a device-specific advertising ID scheme. This value is a boolean, with 1 indicating that a user has opted for limited ad tracking, and 0 indicating that the user has not opted.", "example": "0" }, { "id": 49, "name": "REGULATIONS", "categoryname": "Regulation Info", "categoryindex": 11, "datatype": "Array", "type": "Array", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:REGULATIONS_values_worksheet", "description": "List of applicable regulations.", "descriptionformatted": "List of applicable regulations.", "example": "gdpr" }, { "id": 50, "name": "GDPRCONSENT", "categoryname": "Regulation Info", "categoryindex": 11, "datatype": "string", "type": "string", "introversion": "4.1", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "format": "Base-64 ecoded", "description": "Base64-encoded Cookie Value of IAB GDPR consent info.", "descriptionformatted": "Cookie Value of IAB GDPR consent info.", "example": "BOLqFHuOLqFHuAABAENAAAAAAAAoAAA" }, { "id": 51, "name": "STOREID", "categoryname": "New Macros", "categoryindex": 1, "datatype": "string", "type": "string", "introversion": "4.x", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "For app ads, a platform-specific app store ID such as iTunes store ID. Could be the same as app bundle on some platforms.", "descriptionformatted": "For app ads, a platform-specific app store ID such as iTunes store ID. Could be the same as app bundle on some platforms.", "example": "
  • iOS/tvOS - 886445756
  • Android - com.tubitv
  • Roku - 41468
" }, { "id": 52, "name": "STOREURL", "categoryname": "New Macros", "categoryindex": 1, "datatype": "string", "type": "string", "introversion": "4.x", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "description": "For app ads, the app store URL for the installed app. This macro belongs in the 'Publisher Info' section longer term.", "descriptionformatted": "For app ads, the app store URL for the installed app.", "example": "
  • iOS/tvOS - https://apps.apple.com/us/app/tubi-watch-movies-tv-shows/id886445756
  • Android - com.tubitv
  • Roku - 41468
" }, { "id": 53, "name": "PLAYBACKMETHODS", "categoryname": "New Macros", "categoryindex": 1, "datatype": "integer", "type": "integer", "introversion": "4.x", "support": "Optional", "contexts": "All tracking pixels,VAST request URIs", "values": "see:PLAYBACKMETHODS_values_worksheet", "description": "The value indicating attributes of the inventory such as auto-play and click-to-play activity.", "example": "1" }, { "id": 54, "name": "CONTENTCAT", "categoryname": "New Macros", "categoryindex": 1, "datatype": "Array", "type": "Array", "introversion": "4.x", "support": "Optional", "contexts": "VAST request URIs", "format": "IDVALUE", "description": "List of IDs of the categories relevant to the content the ad is being requested for. \nThe IDs are from the IABTL Content Taxonopmy 2.x.", "descriptionformatted": "List of IDs of the categories relevant to the content the ad is being requested for. \nThe IDs are from the IABTL Content Taxonopmy 2.x.", "example": "“8”,”16”,”1001”,”1021”,”1026”,”1068”,”1215” \nto reflect content that matches - \nContent Categories: Automotive/Convertible (8), Auto Type/Performance Cars(16)\nContent Channel: Editorial/Professional (1001)\nContent Type: Review (1021)\nContent Media Format: Mixed (1026)\nContent Language: en (1068)\nContent Source: Professionally Produced (1215)" }, { "id": 55, "name": "GPPSTRING", "categoryname": "New Macros", "categoryindex": 1, "datatype": "string", "type": "string", "introversion": "4.x", "support": "Optional", "contexts": "All tracking pixels, VAST request URIs", "format": "Encoded", "description": "GPP String from the Global Privacy Platform.", "descriptionformatted": "GPP String from the Global Privacy Platform.", "example": "DBABMA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA" }, { "id": 56, "name": "GPPSECTIONID", "categoryname": "New Macros", "categoryindex": 1, "datatype": "Array", "type": "Array", "introversion": "4.x", "support": "Optional", "contexts": "All tracking pixels, VAST request URIs", "values": "see:GPPSECTIONID_values_worksheet", "description": "Array of the Section ID(s) of the GPP string from GPPSTRING which should be applied. See the GPP Section Information for the list of Section IDs. GPP Section 3 (Header) and 4 (Signal Integrity) do not need to be included.", "descriptionformatted": "Array of the Section ID(s) of the GPP string from GPPSTRING which should be applied. See the GPP Section Information for the list of Section IDs. GPP Section 3 (Header) and 4 (Signal Integrity) do not need to be included.", "example": "5,7" }, { "id": 57, "name": "DSAREQUIRED", "categoryname": "New Macros", "categoryindex": 1, "datatype": "integer", "type": "integer", "introversion": "Next VAST release", "support": "Optional", "contexts": "VAST request URIs", "values": "see:DSAREQUIRED_values_worksheet", "description": "Flag to indicate if DSA information should be made available. This will signal if the bid request belongs to an Online Platform/VLOP, such that a buyer should respond with DSA Transparency information.", "descriptionformatted": "Flag to indicate if DSA information should be made available. This will signal if the bid request belongs to an Online Platform/VLOP, such that a buyer should respond with DSA Transparency information.", "example": 1 }, { "id": 58, "name": "DSAPARAMS", "categoryname": "New Macros", "categoryindex": 1, "datatype": "Array", "type": "Array", "introversion": "Next VAST release", "support": "Optional", "contexts": "VAST request URIs", "values": "see:DSAPARAMS_values_worksheet", "description": "Array of user parameters applied by the platform or sell-side. See the List and Definitions of User Parameters for a list of possible user parameters. ", "descriptionformatted": "Array of user parameters applied by the platform or sell-side. See the List and Definitions of User Parameters for a list of possible user parameters. ", "example": "1_2" }, { "id": 59, "name": "DSAPUBRENDER", "categoryname": "New Macros", "categoryindex": 1, "datatype": "integer", "type": "integer", "introversion": "Next VAST release", "support": "Optional", "contexts": "VAST request URIs", "values": "see:DSAPUBRENDER_values_worksheet", "description": "Signals if the publisher is able to and intends to render an icon or other appropriate user-facing symbol and display the DSA transparency info to the end user.", "descriptionformatted": "Signals if the publisher is able to and intends to render an icon or other appropriate user-facing symbol and display the DSA transparency info to the end user.", "example": 1 } ], "DSAPUBRENDER_values": [ { "value": 1, "description": "Publisher can't render" }, { "value": 2, "description": "Publisher could render depending on adrender" }, { "value": 3, "description": "Publisher will render" } ], "DSAPARAMS_values": [ { "value": 1, "description": "Profiling" }, { "value": 2, "description": "Basic advertising" }, { "value": 3, "description": "Precise geolocation" } ], "DSAREQUIRED_values": [ { "value": 0, "description": "Not required" }, { "value": 1, "description": "Supported, bid responses with or without DSA object will be accepted" }, { "value": 2, "description": "Required, bid responses without DSA object will not be accepted" }, { "value": 3, "description": "Required, bid responses without DSA object will not be accepted, Publisher is an Online Platform" } ], "GPPSECTIONID_values": [ { "value": "1: EU TCF v1 section (deprecated)" }, { "value": "2: EU TCF v2 section" }, { "value": "3: GPP Header section" }, { "value": "4: GPP signal integrity section Connecticut section" }, { "value": "5: Canadian TCF section" }, { "value": "6: USPrivacy String Unencoded Format section" }, { "value": "7: US - national section" }, { "value": "8: US - California section" }, { "value": "9: US - Virginia section" }, { "value": "10: US - Colorado section" }, { "value": "11: US - Utah section" }, { "value": "12: US - Connecticut section" } ], "REGULATIONS_values": [ { "value": "coppa" }, { "value": "gdrp" } ], "INVENTORYSTATE_values": [ { "value": "skippable", "description": "to indicate the ad can be skipped" }, { "value": "autoplayed", "description": "to indicate the ad is autoplayed with audio unmuted" }, { "value": "mautoplayed", "description": "to indicate the ad is autoplayed with audio muted" }, { "value": "optin", "description": "to indicate the user takes an explicit action to knowingly start playback of the ad" } ], "PLAYERSTATE_values": [ { "value": "muted", "description": "to indicate the player is currently muted" }, { "value": "fullscreen", "description": "to indicate the player is currently fullscreen" } ], "CLICKTYPE_values": [ { "value": 0, "description": "not clickable" }, { "value": 1, "description": "clickable on full area of video" }, { "value": 2, "description": "clickable only on associated button or link" }, { "value": 3, "description": "clickable with confirmation dialog" } ], "PLAYBACKMETHODS_values": [ { "value": 1, "description": "Initiates on Page Load with Sound On" }, { "value": 2, "description": "Initiates on Page Load with Sound Off by Default" }, { "value": 3, "description": "Initiates on Click with Sound On" }, { "value": 4, "description": "Initiates on Mouse-Over with Sound On" }, { "value": 5, "description": "Initiates on Entering Viewport with Sound On" }, { "value": 6, "description": "Initiates on Entering Viewport with Sound Off by Default" }, { "value": 7, "description": "Indicates content is playing back-to-back without any user interaction" } ], "PLAYERCAPABILITIES_values": [ { "value": "skip", "description": "to indicate the user's ability to skip the ad" }, { "value": "mute", "description": "to indicate the user's ability to mute/unmute audio" }, { "value": "autoplay", "description": "to indicate the player's ability to autoplay media with audio; also implies mautoplay" }, { "value": "mautoplay", "description": "to indicate the player's ability to autoplay media when muted" }, { "value": "fullscreen", "description": "to indicate the user's ability to enter fullscreen" }, { "value": "icon", "description": "to indicate the player's ability to render NAI icons from VAST" } ], "BREAKPOSITION_values": [ { "value": 1, "description": "for pre-roll" }, { "value": 2, "description": "for mid-roll" }, { "value": 3, "description": "for post-roll" }, { "value": 4, "description": "for standalone" }, { "value": 0, "description": "for none of the above/other" } ], "SERVERSIDE_values": [ { "value": 0, "description": "Client fires request or tracking call without server intermediary" }, { "value": 1, "description": "Server fires request or tracking call on behalf of a client. The client told the server to act on its behalf" }, { "value": 2, "description": "Server fires request or tracking call on behalf of another server, unknown party, or based on its own decision, without an explicit signal from the client" } ], "displaycolumns": [ { "column": "datatype" }, { "column": "introversion" }, { "column": "support" }, { "column": "contexts" }, { "column": "format" }, { "column": "values" }, { "column": "descriptionformatted" }, { "column": "example" } ], "labels": [ { "property": "name", "label": "Macro" }, { "property": "datatype", "label": "Data Type" }, { "property": "type", "label": "Type" }, { "property": "introversion", "label": "Introduced In" }, { "property": "support", "label": "Support" }, { "property": "contexts", "label": "Contexts" }, { "property": "format", "label": "Format" }, { "property": "values", "label": "Possible Values" }, { "property": "descriptionformatted", "label": "Description" }, { "property": "example", "label": "Example" } ], "datatypes": [ { "name": "string" }, { "name": "integer" }, { "name": "number" }, { "name": "Array" }, { "name": "Array(2)" }, { "name": "Array" }, { "name": "Array(2)" }, { "name": "Array" }, { "name": "Array(2)" }, { "name": "Array" }, { "name": "Array(2)" } ], "categories": [ { "index": 1, "name": "New Macros" }, { "index": 2, "name": "Generic Macros" }, { "index": 3, "name": "Ad Break Info" }, { "index": 4, "name": "Client Info" }, { "index": 5, "name": "Publisher Info" }, { "index": 6, "name": "Capabilities Info" }, { "index": 7, "name": "Player State Info" }, { "index": 8, "name": "Click Info" }, { "index": 9, "name": "Error Info" }, { "index": 10, "name": "Verification Info" }, { "index": 11, "name": "Regulation Info" } ] }