Ad-Integration - Video

&iu

(Ad Unit)

=/40748507/new_foa/video/not_in_use/video_click2play

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

&description_url

(Description URL)

=[placeholder]

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

&tfcd

(Tag for child-directed)

=0

The child-directed parameter accepts a constant value which tags the ad request for child-directed treatment.

Usage example

tfcd=1

&npa

(non-personalized ad)

=0

The non-personalized ads parameter accepts a constant value to indicate that the ad request should be treated as non-personalized.

You must either specifically set npa=1 or include simply npa (without a set value) to tag the request as non-personalized. Ad requests either missing this parameter, or set to npa=0, default to personalized ads.

Usage example

Non-personalized ads:
npa=1

&sz

(Size)

=640x480

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.

&gdfp_req

(Ad Manager schema indicator)

=1

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

&output

(Ad output format)

=vast

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

&unviewed_position_start

(delayed impressions)

=1

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

&vpmute

(video player 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

Recommended for Programmatic monetization

&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

Interstitial:
plcmt=3

No content/stand alone (Outstream?):
plcmt=4

Requirement

Recommended for Programmatic monetization

&env

(envirement)

=instream

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

&impl

=s

The parameter describes the request typ and is necessary for video advanced feautures within the video player.

&correlator

(Korrelator)

=

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