Supply targeting parameters to your stream

Current ad unit.

_{This should follow the format:
/network_id/directory/ad_unit}

Key-value pairs that should be used for Ad Manager campaign targeting. Some platforms require URL encoding.

The URL encoding requirement does not apply when using the IMA DAI SDK for HTML5, as the value is automatically encoded. This parameter will not work if it is already encoded on HTML5.

Examples with multiple key-value pairs, such as:

• section=sports 
• page=golf,tennis

SSB streams: Encode and concatenate the entire cust_params value, but do not double-encode.

cust_params=
  "section%3Dsports
  %26page%3Dgolf%2Ctennis"

Chromecast:
Encode the values only.

streamRequest.
adTagParameters = {
  "cust_params":
  "section=sports&
  multi=golf%2Ctennis"};

Roku: Encode and concatenate the entire cust_params value, but do not double-encode.

request.adTagParameters =   "cust_params=
  section%3Dsports
  %26page%3Dgolf%2Ctennis"

iOS, and tvOS: Do not encode anything.

request.adTagParameters = @{
  @"cust_params" :
  @"section=sports&
  multi=golf,tennis"};

Android: Do not encode anything.

Map<String, String>
adTagParams =
  new HashMap<>();
  adTagParams.put(
  "cust_params",
  "ge=0&gr=2");

Overrides the sz parameter from your default ad tag allowing you to change dynamically for different devices.

Do not include the "v" after the size.

Tag a request for child-directed treatment.

When a DAI request includes tfcd=1, any values assigned to the rdid, idtype, or is_lat parameters are removed to comply with COPPA.

tfcd=1

description_url

The value should describe the video playing on the page. Usually, it's the page that houses the video player, but could also be a page with text that describes the video.

You must always url-encode description_url on SSB streams and when using the IMA DAI SDK for Roku. This requirement does not apply when using the IMA DAI SDK for HTML5, as the value is automatically encoded. This parameter will not work if it is already encoded on HTML5.

This parameter is not set automatically by the IMA SDK. It needs to be set manually.

This field is required if you use Ad Exchange. Learn more

URL-encoded example:
description_url=
http%3A%2F%2Fsample.com
%2Fgolf.html

Non-encoded example:
description_url=
http://sample.com/
golf.html

Comma-separated list of companion ad sizes.

_{Companion ads are only supported with DAI when you use the HTML5 SDK.}

Indicates the name of the partner player. This would mostly be used by partners like JWPlayer, Brightcove, Ooyala that are integrating with the SDK.

Indicates the version of the partner player. This should only be set if mpt is also set, and represents the version of the partners player that is integrating with the SDK.

You can find this ID in the Ad Manager URL when viewing the settings for the break template in the Ad Manager interface. It appears as the value for the break_template_id parameter.

The an parameter is the app name.

It should be applied to requests sent from mobile app and connected TV devices, as most programmatic video ads require it.*

The IMA SDK will automatically populate this, but it must be manually specified with DAI API and SSB (non-SDK environments).

_{* While the app name should be a human-readable name, on iOS and tvOS, it's not possible for the SDK to access the 9-digit App Store ID. In these cases, the SDK sends the app bundle via the an parameter (in the format com.package.publisher).}

an=sample%20app

Undefined traffic type:
trt=0

Purchased traffic:
trt=1

Organic traffic:
trt=2

Indicates whether the player intends to continuously play the content videos one after another, similar to a TV broadcast.

Possible values are 2 if continuous play is ON, and 1 if OFF.

This parameter should be left unset if it is unknown.

Continuous play OFF:
vconp=1

Indicates whether the ad starts through autoplay or click.

Possible values are click if the page waits for a user action or auto if the video plays automatically.

This parameter should be left unset if it is unknown.

Click:
vpa=click

Indicates whether the ad playback starts while the video player is muted.

Possible values are 1 for muted, and 0 for unmuted.

This parameter should be left unset if it is unknown.

Unmuted:
vpmute=0

Specify npa=1 to mark the ad request as non-personalized. Omission of the parameter defaults to personalized ads.

The OMID partner name parameter accepts a variable value which indicates the name of the partner integrating OMID measurement, and the partner version.

This parameter is only applicable to publishers wanting Active View measurement when using the Open Measurement SDK (OM SDK). This should not be used when using the IMA SDK as it is set automatically.

To indicate OMID support when using Programmatic Access Library (PAL), you need to use the omidPartnerName and omidPartnerVersionAPIs to set the partner name and version. When you're not using either PAL or IMA, you must set theomid_pandsdk_apis parameters (the supported APIs, which could also include other comma separated APIs).

When using PAL:

request.omidPartnerName = 'examplepartnername' request.omidPartnerVersion = '1.0.0.0'
When not using PAL: omid_p=examplepartnername/1.0.0.0&sdk_apis=7

These fields are used to pass TCF v2.0 consent information for both in-bound and out-bound cookie sync requests.

See the GDPR specifications.

For integrations that use the Programmatic Access Library (PAL), the video nonce parameter accepts a variable string value.

The nonce is URL safe—you don't need to URL-encode it.

Note: If you previously provided a nonce using the legacy paln parameter, it is strongly recommended to migrate to the givn parameter and stop sending paln. Do not include both parameters.

A list of consented Google Ad Tech Providers that are not registered with IAB.

See the Additional Consent specifications.

You must either specifically set rdp=1 or include simply rdp (without a set value) to restrict data processing. Ad requests either missing this parameter, or set to rdp=0, will not restrict, unless the Restrict Data Processing network setting is enabled.

rdp=1

The SDK API framework parameter accepts a comma-separated list of constant integer values which indicate all of the API frameworks that the player supports.

See a list of possible API Framework values.

This parameter is used by publishers that use the Programmatic Access Library (PAL). If you attempt to set values to this parameter while using the IMA SDK, the values will be overridden with the values supported by the IMA SDK.

A type of privacy-preserving advertising identifier that can be used for frequency capping purposes only. Per the IAB's IFA guidelines, this parameter must be populated in UUID format. Learn more

You can opt out of passing the session ID by setting sid=0.

sid=123e4567-e89b-12d3
-a456-426614174000

Indicates the video player's support for rendering "Why this Ad?".

This 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 this DAI API guide.* 

WTA is not supported for SSB.

This field is required if you use Ad Exchange. Learn more

_{* Support for IconClickFallbackImage is not required, except for on CTV devices.}

Supported:
wta=1

Unsupported:
wta=0