Required parameters for app

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 required for tag-based video solutions for app when not integrating with the IMA SDK.

See the list of required parameters for web or the recommended parameters for Programmatic monetization.

 Jump to a specific parameter in the list

an correlator description_url env gdfp_req idtype

is_lat iu msid output pvid pvid_s

rdid sz unviewed_position_start url 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
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 msid parameter is not sent, and the SDK sends the app bundle via the an parameter. Usage example msid=com.package.publisher&an=sample%20app 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: com.publisher.deviceplatform Requirement Both parameters are required for app Recommended for Programmatic monetization
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
pvid (App set ID) pvid_s (App set scope)	The app set ID values are needed for monetization when users opt out of personalization on Android devices. The pvid parameter accepts a variable value which is set to the Android app set ID, and the pvid_s parameter accepts a constant value that represents the scope of the app set ID (either scope_app or scope_developer). While the IMA/PAL SDK automatically passes this field, publishers with non-SDK implementations must call the app set SDK and pass these parameters manually on ad request. See the Android documentation on how to retrieve the app set ID. Usage example pvid=[AppSetID_value] pvid_s=scope_app Requirement Required for app Recommended for Programmatic monetization
rdid idtype is_lat (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 rdid, idtype, and is_lat. On SSB streams, you must pass these as explicit parameters, just as you would on a client-side ad request. Learn more about device identifiers. Nearly all programmatic video ads require the presence of these values. Starting with iOS 14.5, Apple has deprecated the LAT signal. Google instead relies on the presence of a non-zero IDFA to indicate that the user has consented to tracking on versions of iOS that support App Tracking Transparency. As such, a valid UserAgent indicating the correct OS version is required. Usage example See detailed examples of resettable device identifiers. Requirement Required for app Recommended for 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
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