Required and recommended parameters for web

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 web when not when not integrating with the IMA SDK.

See the list of required parameters for app or the required and commended parameters for Programmatic monetization.

 Jump to a specific parameter in the list

correlator description_url env gdfp_req iu

output plcmt sz unviewed_position_start

url vpa vpmute wta

 

Parameter	Details
correlator (Correlator)	The correlator parameter accepts a variable value that is shared by multiple requests coming from the same page view. It's used to implement competitive exclusions, including those in cookieless environments. If the IMA SDK is used, the correlator value is set automatically. If your player attempts to set this value, the SDK overwrites it with its own value. If the IMA SDK is not used, ensure that you set this value to a truly random, positive, integer value that is not being reused by multiple page views. Usage example correlator=4345645667 Requirement Required for web and app Recommended 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 description_url page content dynamically from predefined blocks. Learn more about providing a distinct description URL. The description_url value must be URL-encoded for web page video players and CTV/OTT devices and non-encoded for mobile in-app video players. This parameter is not set automatically by the IMA SDK. It needs to be set manually. Usage example URL-encoded: description_url= https%3A%2F%2Fwww.sample.com%2Fgolf.html Non-encoded: description_url= https://www.sample.com/golf.html Requirement Required for web, app, and Ad Exchange Recommended for Programmatic monetization
env (Environment)	The environment parameter accepts a constant value that indicates an in-stream request, or that the request is specifically from a video player. Possible values are instream, which can be used for video and audio ads, or vp which can only be used for video ads. Usage example Video and/or audio: env=instream Video only: env=vp Requirement Required for web and app
gdfp_req (Ad Manager schema indicator)	The Ad Manager schema indictor parameter accepts a constant value which indicates that the user is on the Ad Manager schema. Usage example gdfp_req=1 Requirement Required for web and app
iu (Ad unit)	The ad unit parameter accepts a variable value which should be set to the current ad unit, in the format: /network_code/.../ad_unit Usage example iu=/6062/videodemo Requirement Required for web and app
output (Ad output format)	The ad output format parameter accepts a constant value which should be set to the output format of ad. Use output=vast for the default VAST version set for your network. For specific ad tags or parts of your site, you can request specific VAST or VMAP versions. For VAST, if your video player uses the IMA SDK, the output parameter for a video ad request will always be set to output=xml_vast4. This poses no reliability risk as the SDK is backwards compatible with all VAST versions that any third-party ad server may serve. Use output=vmap to return the default VMAP version you have activated for your network (for example, VMAP 1). If you return VAST inside of VMAP, you can use xml_vmap1_vast3 or xml_vmap1_vast4 to specify the VAST version to return. Usage example Your network's default VAST setting: output=vast VAST 4: output=xml_vast4 Your network's default VMAP setting: output=vmap VMAP 1: output=xml_vmap1 VMAP 1, returning VAST 4: output=xml_vmap1_vast4 Requirement Required for web and app
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 example In-stream request: plcmt=1 Accompanying content request: plcmt=2 Requirement   Required for web and Programmatic monetization
sz (Size)	The size parameter accepts a variable value which should be set to the size of master video ad slot. Multiple sizes should be separated by the pipe (|) character. Do not include "v" after the size. Usage example sz=400x300 Requirement Required for web and app This parameter is optional if only requesting ad_type=audio.
unviewed_position_start (Delayed impressions)	The delayed impressions parameter accepts a constant value to indicate delayed impressions for video. Usage example unviewed_position_start=1 Requirement Required for web and app
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 url= https%3A%2F%2Fwww.videoad.com%2Fgolf.html * 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: url= https%3A%2F%2F<app/bundleid>.adsenseformobileapps.com Requirement Required for web and app Recommended 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 click if the page waits for a user action or auto if the video plays automatically. This parameter should be left unset if it is unknown. Usage example Autoplay: vpa=auto Click to play: vpa=click Requirement Recommended 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 example Muted: vpmute=1 Unmuted: vpmute=0 Requirement   Required for web and 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 &wta parameter is sent, this defaults to &wta=1. The ad badging functionality is supported automatically when using the IMA SDK. When the IMA SDK is not used, video players must implement VAST Icon and IconClickFallbackImage support, as documented in the IAB VAST standard. Publishers are required to send &wta=0 if the publisher will not render the AdChoices icon, as provided in the VAST response. An ad request with &wta=1 or no &wta parameter is understood to indicate that the publisher will render the provided AdChoices information. Audio ad requests may send wta=1 if the AdChoices icon, as provided in the VAST response, will be rendered on companions or otherwise provided to the user. For traffic from the EEA, requests with &wta=0 will not be eligible for reservation creatives where Google badging is enabled. 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 example Supported: wta=1 or no wta parameter Unsupported: wta=0 Requirement Required for Ad Exchange Required for web and app EEA traffic Recommended for Programmatic monetization