VAST ad tag URL parameters

Required 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 required 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 recommended parameters for Programmatic monetization.

Jump to a specific parameter in the list

correlator
description_url
env

gdfp_req
iu
output

sz
unviewed_position_start
url

 
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, numerical 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. Usually, it's the page with the video player, but could also be a page with text that describes the video.

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 webapp, and Ad Exchange

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_id/.../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

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 overwrites it and set its own value. 

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.*

Usage example

url=https://www.videoad.com/golf.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=<app/bundleid>.adsenseformobileapps.com/

Requirement

Required for web and app

Recommended for Programmatic monetization

Was this helpful?
How can we improve it?

Need more help?

Sign in for additional support options to quickly solve your issue

Search
Clear search
Close search
Google apps
Main menu
Search Help Center
true
148
false