Ad Exchange video tag parameters for IMA3

ad_type

---

(String) Specifies the type of ad desired. Multiple values can be linked together 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 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.

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.

Example

http%3A%2F%2Fsimplevideoad.com%2Fgolf.html

 

videoad_start_delay

---

(Integer) The number of milliseconds into the video at which the ad will play. Defaults to a mid-roll 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

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 is only 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 play automatically.

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)