Ad Exchange video tag parameters for IMA3

The table below shows how Ad Exchange in-stream video tags can be setup for publishers. Once you create an ad tag for video and include the required parameters, such as description_url, you can append any of the recommended or optional parameters to achieve your desired ad response.

 
  URL parameter

Required

ad_type
client
description_url*

Recommended

slotname
adsafe
videoad_start_delay
hl
max_ad_duration
min_ad_duration
sdmax
vid_t
vid_d
vid_kw
vpa
vpmute

Optional

adtest
cust_age
cust_gender
host
h_ch
overlay

 * Must be URL encoded

Begin with the base URL

The base URL is URL to which all query parameters are added. Descriptions, possible values, and examples of these parameters can be found below.

Base URL: http://googleads.g.doubleclick.net/pagead/ads?

Required parameters

ad_type


(String) Specifies the type of ad desired. These should be concatenated using an underscore.

Values

  • video
      All video ads (equivalent to standardvideo_skippablevideo).
  • skippablevideo
      Only skippable video ads (may require additional publisher permissions to receive skippable ads).
  • standardvideo
      Only non-skippable video ads
  • image
      Allows image ads that fit within the specified non-linear slot size.
  • text
      Allows text ads.

Examples

  • &ad_type=video_text_image (allows all formats)
  • &ad_type=video_text (allows any video format and text ads)
  • &ad_type=standardvideo_image (allows only standard, non-skippable video and image ads)

client


(String) The web property ID of the publisher.

Example

&client=ca-video-afvtest

description_url


(String) A full, URL-encoded URL of an HTML page that describes the video. The URL of the page that contains the player that is making the request. This is required if you use Ad Exchange for dynamic allocation.

Example

http%3A%2F%2Fwww.simplevideoad.com%2Fgolf.html

 

Full URL example

The following is a URL example containing the minimum required parameters: http://googleads.g.doubleclick.net/pagead/ads?client=ca-video- afvtest&ad_type=video&description_url=http%3A%2F%2Fwww.simplevideoad.com%2Fgolf.html%2Fpage%3Fkey%3Dvalue%26key2%3Dvalue2

Requests video ads for the publisher, ca-video-afvtest, with a description URL of https://myurl.com/page?key=value&key2=value2

Recommended and optional parameters

adsafe


(String) Determines the setting used to filter ads that display. Default is high.

Values

  • high (default)
      Returns family-safe ads. Does not return non-family-safe or adult sexual content.
  • medium
      Returns family-safe and non-family-safe ads (such as ads for gambling or prescription drugs).
    Does not return adult sexual content ads.

Example

adsafe=high

adtest


(String) Specifies whether this is a test implementation. Possible values are on or off. If set to on, impressions and clicks are not recorded in an AFV account. This parameter MUST be used during testing. Defaults to off if not set.

Values

  • off (default)
      All ads bill normally. This is the setting that should be used for production.
  • on
      This setting ensures that no ads log impressions or clicks for use during testing.

Example

adtest=on

videoad_start_delay


(Integer) The number of milliseconds into the video at which the ad will play. Defaults to a midroll value, 1, specifically.

Values

  • -1
      Specifies a post-roll ad that will be displayed at the end of the content.
  • 0
      Specifies a pre-roll ad that will be displayed before content playback begins.
  • Any positive integer
      Specifies a mid-roll that will play after this number of milliseconds of content playback.;

Examples

  • videoad_start_delay=-1 (post-roll)
  • videoad_start_delay=15000 (ad will play at 15 seconds into the content)

slotname


(String) Represents the AdSense/Ad Exchange ad slot ID. This value is generated by the publisher frontend and identifies the ad slot(ad unit) and its settings. Only one ad slot may be passed in per ad request.

Example

slotname=1

cust_age


(Integer) Specifies the age of the user. Exact age is supported, as well as an age group defined in com.google.ads.ima.api.Demographics.

Examples

  • cust_age=1001 (age 18 to 24)
  • cust_age=38 (exactly age 38)

cust_gender


(Integer) Specifies the gender of the user as defined in com.google.ads.ima.api.Demographics.

Values

  • 1
      Specifies male
  • 2
      Specifies female

Examples

  • cust_gender=1 (male)
  • cust_gender=2 (female)

host


(String) Host ID to use for 3-way revenue sharing.

Example

host=ca-host-test (splits revenue with this host)

h_ch


(Number) Tier ID used to specify the level of revenue sharing between publisher and host.

Example

ht_id=2 (tier 2 host)

hl


(String) A language code used to request ads in that language. This may be any ISO 639-1 (two-letter) or ISO 639-2 (three-letter) code. See the full list of valid codes.

Examples

  • hl=en (English)
  • hl=es (Spanish)

max_ad_duration


(Integer) Specifies maximum video length that must be returned in milliseconds. Defaults to 100 seconds if not set.

Example

max_ad_duration=30000 (maximum duration of any non-skippable ad is 30 seconds)

min_ad_duration


(Integer) Specifies minimum video length that must be returned in milliseconds. Defaults to 0 seconds if not set.

Examples

  • min_ad_duration=15000 (the duration of a non-skippable ad must be 15 seconds or longer)
  • min_ad_duration=0 (the duration will only be restricted by the max_ad_duration value) 

sdmax


(Integer) Specifies the maximum video length for skippable ads in milliseconds. Defaults to unlimited if not set.

Example

sdmax=120000 (the duration of the returned skippable ad cannot exceed 2 minutes)

overlay


(Integer) Used to limit the requested overlay size to non-linear bottom-third overlays only.
By default, no limit is set.

Examples

  • overlay=1 (only bottom-third overlay sizes are eligible; full-slot overlays are not requested)
  • overlay=0 (default value, does not set a limit for overlay sizes; overlay sizes serve based on AdsRequest.nonLinearAdSlotWidth and AdsRequest.nonLinearAdSlotHeight)

vid_t


(String) The content video title.

Example

vid_t=Video%20Title (only content videos with the title "Video Title")

vid_d


(Integer) The content video duration, in seconds.

Example

vid_d=1800 (only content videos with a duration of 1800 seconds)

vid_kw


(String) A comma delimited list of content video keywords. For example, the genre, key/values, or other metadata.

Example

vid_kw=drama,series,finale (only content videos matching these keywords)

vpa


(Integer) Specifies whether video ads should automatically play.

Values

  • 0  Specifies click-to-play video
  • 1  Specifies autoplay video

Examples

  • vpa=0 (click-to-play)
  • vpa=1 (autoplay)

vpmute


(Integer) Specifies whether video ads should begin in a muted state.

Values

  • 0  Specifies sound on (default)
  • 1  Specifies muted

Examples

  • vpmute=0 (sound on)
  • vpmute=1 (muted)
Was this article helpful?
How can we improve it?