Implementing a tag-based video solution for Ad Exchange demand without the use of the IMA SDK is a beta offering and might not be available for your network. You can contact your account manager for more information.
The following is a subset of the VAST ad tag URL parameters. These parameters are for tag-based video solutions for Programmatic when not integrating with the IMA SDK.
See the list of required and recommended parameters for web or the required parameters for app.
Jump to a specific parameter in the list
Parameter | Details | |
---|---|---|
hl
(Language) |
The language parameter accepts a constant value which is used to request ads in that language, and for language of ad selection and video ad rendering in dynamic allocation to Ad Exchange or AdSense Video. The parameter value can be any ISO 639-1 (two-letter) or ISO 639-2 (three-letter) code. See a list of valid codes. If omitted, the value defaults to any language with ad targeting by language in Ad Exchange. Usage example
RequirementRecommended for Programmatic monetization |
|
description_url
(Description URL) |
The description URL parameter accepts a variable value that should describe the video playing on the page. Outline the page with 1-3 paragraphs describing the content. For example, stitch together the The This parameter is not set automatically by the IMA SDK. It needs to be set manually. Usage exampleURL-encoded: Non-encoded: RequirementRequired for web, app, and Ad Exchange Recommended for Programmatic monetization |
|
dth
(Device type hint) |
The device type hint parameter accepts a constant value that helps reduce device misclassification, specifically on connected TV and set top box environments. Device misclassification may result from unintended errors from the publisher or connected TV OEM. This parameter would be used in conjunction with other signals for Google to automatically flag instances where connected TV inventory may be reclassified. Usage examplesRequests from:
RequirementRecommended for Programmatic monetization on connected TV. This parameter is recommended for PAL and PAI (non-SDK) implementations. It is not needed for IMA SDK or DAI SDK. |
|
msid
(App ID) an
(App name) |
The app ID and app name parameters accept variable values which should be applied to requests sent from mobile app and connected TV devices, as most programmatic video ads require them. The IMA SDK will automatically populate both parameters, but they must be manually specified in non-SDK environments, including direct VAST calls, or when using Programmatic Access Library (PAL) or Publisher Authenticated Inventory (PAI). While the app name should be a human-readable name, on iOS and tvOS, it's not possible for the SDK to access the app ID. In these cases, the Usage example
App IDs are named and formatted differently across different app stores. See the IAB guidelines for app identification, or examples of common unique identifiers. For platforms where an app store does not exist, the IAB recommends publishers use the following format for store IDs: RequirementBoth parameters are required for app Recommended for Programmatic monetization |
|
plcmt
(Placement) |
The placement parameter accepts a constant value which is used to indicate whether or not the in-stream inventory is declared as in-stream or accompanying per the guidance in the IAB specifications. For non-in-stream requests, this field is populated for buyers automatically based on the declared inventory format, and will override any in-stream or accompanying content declaration. Usage exampleIn-stream request: Accompanying content request: RequirementRequired for web and Programmatic monetization |
|
pp
(Creative profile) |
The creative profile parameter accepts a variable value which controls the creatives eligible to serve based on the configuration set up in a video and audio creative profile. Usage example
RequirementRecommended for Programmatic monetization |
|
rdid
(Resettable device identifiers) |
The resettable device identifiers accept variable values. With built-in applications (not on web or mobile web), the SDK passes resettable device identifiers for user targeting into your stream requests with the parameters for Nearly all programmatic video ads require the presence of these values.
Usage exampleSee detailed examples of resettable device identifiers. RequirementRequired for app Recommended for Programmatic monetization |
|
sid
(Session ID) |
The session ID parameter accepts a variable value which is a privacy-preserving advertising identifier that is used for frequency capping purposes only. Session ID is supported for in-stream video requests from connected TVs and on in-stream video inventory from mobile app devices. It is not currently supported for web. Per the IAB's IFA guidelines, this parameter must be populated in UUID format. Learn more about resettable device identifiers for user targeting. You can opt out of passing the session ID by setting Usage example
RequirementRecommended for Programmatic monetization |
|
url
(URL) |
The URL parameter accepts a variable value which should be set to the full URL from which the request is sent. This value is needed to help buyers identify and understand the context of where this request is coming from. To the extent possible, this value should be dynamically populated on the ad request. On a web page, this is the URL of the page that displays the video player. If you use the IMA SDK, the URL value is set automatically. If your player sets this value, the IMA SDK will respect the value being set. In an app (mobile or CTV), this value should be set to a URL that most accurately represents the video or audio inventory being monetized. For instance, if the user is watching a video within a mobile app that is also available on a desktop equivalent URL.* The value of this parameter should be encoded. Usage example
* For apps, if it is not possible to set this parameter to a variable URL value, it's recommended that it be set with the following pattern: RequirementRecommended for Programmatic monetization |
|
vpa
(Video play automatic) |
Recommended per MRC Video Measurement Guidelines The video play automatic parameter accepts a constant value which indicates whether video content in an ad starts through autoplay or click. Possible values are This parameter should be left unset if it is unknown. Usage exampleAutoplay: Click to play: RequirementRecommended for Programmatic monetization |
|
vpmute
(Video play mute) |
Recommended per MRC Video Measurement Guidelines The muted video parameter accepts a constant value which indicates whether the ad playback starts while the video player is muted. Usage exampleMuted: Unmuted: RequirementRequired for web and Programmatic monetization |
|
vpos
(Video position) |
The video position parameter accepts a constant value which indicates whether the ad request is being sent from pre-roll, mid-roll or post-roll. Usage examplePre-roll: Mid-roll: Post-roll: RequirementRecommended for Programmatic monetization |
|
wta
(Why this ad) |
The "Why this ad?" parameter accepts a constant value which indicates the video player's support for rendering ad badging. When no The ad badging functionality is supported automatically when using the IMA SDK. When the IMA SDK is not used, video players must implement VAST Publishers are required to send Audio ad requests may send For traffic from the EEA, requests with Ads must comply with applicable regulatory requirements for ads served in the European Economic Area (EEA). This includes a mechanism for users to report illegal content. Publishers must notify Google of any illegal content reports using the appropriate form. Usage exampleSupported:
Unsupported: RequirementRequired for Ad Exchange Required for web and app EEA traffic Recommended for Programmatic monetization |