Google Ad Manager

ad.adUnit

Required

Identifies the directory path to an ad unit.

Example:

ad.networkID

Required

Identifies the network ID for the Google account.

Example:

ad.output

Required

Indicates the response format. Valid values are:

VODVideo On-Demand (VOD) allows the playback of content that was previously encoded and stored within our system. One use for VOD is to allow viewers to stream your content at any time. Only
Selecting a VAST format (i.e., xml__vast3 or xml_vast2) for a VOD playback session causes our service to create a VMAP template. This allows our service to manage all of the ad requests within that VOD asset across all ad breaks.

Example:

ad.serverUrl

Required

Identifies the URL to the Google ad decision server.

Example:

ad.sz

Required

Indicates the size of the master video ad slot.

Example:

ad.ad_rule

Determines whether video ad requests will be an ad rule request.

Valid values are:

• 0: VAST Template
• 1: Ad rules playlist

Example:

Global Data Privacy Parameter. A string that contains a list of consented and/or disclosed Google ad technology providers (ATPs) that are not registered with IAB.

Example:

ad.ciu_szs

Identifies one or more companion sizes as a comma-separated list.

Example:

ad.cmsid

Identifies the CMS source ID for the system hosting video content for your network. Google automatically assigns one ID per content source.

ad.cust_params

Defines custom targeting parameters.

Example:

ad.description_url

Identifies the URL of the page that contains the player that submitted the request. This URL should be specific to the video as opposed to the domain for all ad requests.

ad.excl_cat

Ad exclusion category. Blocks any line items containing the exclusion label from being eligible for a given ad request. Use this parameter in conjunction with the scp and cust_params parameters.

Example:

ad.extcalls

Set it to liveconnect to Instruct Google Ad Manager to enable integration with LiveConnect.

Example:

Global Data Privacy Parameter. Possible values: 0 / 1

0=GDPR does not apply.

1=GDPR applies.

Example:

Global Data Privacy Parameter. URL-safe, base 64-encoded Transparency & Consent string. Only meaningful if gdpr=1.

Example:

Global Privacy Platform Parameter. This specifics the US-National Consent String and its value.

Example:

Global Privacy Platform Parameter. This specifies the GPP consent string type.

Example:

ad.hl

Identifies the language code used to request the ads.

Example:

Default value:

ad.idtype

Identifies the type of device.

Key information:

• This parameter is required for frequency capping.
• This parameter requires the ad.is_lat and ad.rdid parameters.

• Valid case-sensitive values are:

  • idfa: Apple phones (iOS)
  • tvOS: AppleTV (tvOS)
  • adid: Android and Chromecast
  • rida: Roku
  • msai: Xbox

Example:

ad.is_lat

Determines whether the Limit Ad Tracking (LAT) will be enabled. LAT allows users to opt-out from user behavior-based ad targeting.

Key information:

• This parameter is required for frequency capping.
• This parameter requires the ad.rdid and ad.idtype parameters.

• Valid values are:

  • 0: Disables LAT.
  • 1: Enables LAT.

Example:

ad.lip

Required for a request from the last position in a standardized ad pod.

Example:

The limited ads parameter accepts a constant value that indicates whether to serve ads in a limited way in the absence of consent for the use of cookies or other local identifiers. Unlike other URL parameters, setting ltd=1 changes the behavior of the IMA SDK to treat the request as ID-less and to disallow storage.

Example:

ad.max_ad_duration

Required for min_ad_duration.

Determines the ad's maximum duration in milliseconds. Use this parameter when requesting a single ad.

Example:

ad.min_ad_duration

Required for max_ad_duration.

Determines the ad's minimum duration in milliseconds. Use this parameter when requesting a single ad.

Example:

ad.mridx

Determines whether the request to the ad server will identify the current mid-roll ad break by its position within the current playback sessionA playback session identifies the time period during which a viewer plays your content. A playback session starts when the player initiates playback. At which time, the system assigns a unique ID to the player's session. This session persists until the user closes the player/web browser/device playback environment or the session has been inactive for an extended time period. A single playback session may represent the playback of multiple assets and/or channels.. Include this information by setting this parameter to:

Example:

View deprecated behavior.

The following behavior has been deprecated and will be discontinuedIdentifies functionality that is no longer in service. in the near future.

Indicates the mid-roll for which the ad request was submitted. This value is a 1-based index (e.g., 1 = first mid-roll, 2 = second mid-roll, and 3 = third mid-roll).

Example:

ad.mridx=3

You may also pass the current mid-roll ad break's position within the current program by enabling the ad.pod parameter.

ad.npa

Determines whether non-personalized ads will be requested. This parameter is required for compliance with the EU General Data Protection Regulation (GDPR).

Valid values are:

• 0: Indicates that the ad request is eligible for personalized ads.
• 1: Indicates that the ad request should only serve non-personalized ads.

Example:

ad.paln

Pass client data to Google Ad Manager.

ad.pmad

Determines the maximum number of ads in a pod.

Example:

ad.pod

Determines whether the request to the ad server will identify the current mid-roll ad break by its position within the current program. Use this parameter for competitive exclusions, frequency capping, and related features. Include this information by setting this parameter to:

By default, the position of the current mid-roll ad break is calculated based off of the ad breaks detected within the asset corresponding to the current program. However, you may manually indicate this information within a live event by setting the breakSeq metadata field to a 1-based index value that identifies the current mid-roll ad break's position within the current program (e.g., 1 = first pod, 2 = second pod, and 3 = third pod).

Use the breakSeq metadata field to ensure data consistency when restarting or switching between Live Slicers.

Pass metadata (e.g., breakSeq) via the add_meta endpoint in the Live Slicer API.

Example:

View deprecated behavior.

The following behavior has been deprecated and will be discontinuedIdentifies functionality that is no longer in service. in the near future.

Represents a pod within a video. This value is a 1-based index (e.g., 1 = first pod, 2 = second pod, and 3 = third pod).

Example:

ad.pod=3

You may also pass the current mid-roll ad break's position within the current playback session by enabling the ad.mridx parameter.

ad.postroll

Determines whether playback will include a post-roll.

Valid values are:

• 1: True
• 0: False

Example:

ad.pp

Identifies a video creative profile that determines which creatives are eligible to be served.

Example:

ad.ppid

Indicates a Publisher Provided Identifier (PPID). Google Ad Manager uses this ID for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

ad.ppos

Represents the position within a pod. This value is a 1-based index (e.g., 1 = first position, 2 = second position, and 3 = third position). This parameter is required for companion autofill. Use this parameter for competitive exclusions, frequency capping, and related features.

Example:

ad.preroll

Determines whether playback will include a pre-roll.

Valid values are:

• 1: True
• 0: False

Example:

ad.rdid

Identifies a device by its identifier (e.g., Google AdID, Apple IDFA, Roku RIDA, or Xbox MSAI).

Key information:

• This parameter is required for frequency capping.
• This parameter requires the ad.is_lat and ad.idtype parameters.
• This ID may be updated by the user at any time.

Example:

ad.scor

An integer generated for each video stream; the number needs to be the same within a stream and unique within a pageview. Use this parameter for competitive exclusions, frequency capping, and related features when a user is watching multiple videos on the same page.

Example:

ad.scp

Identifies slot-specific custom parameters.

Example:

ad.session_id

Identifies the playback session using a universally unique identifier (UUID). You may use this parameter to preserve the viewer's privacy when setting frequency caps for ad creatives.

Example:

ad.ssss

Indicates the stitching partner.

Example:

ad.tfcd

Determines whether an ad request requires child-directed treatment. This parameter is required for compliance with the Children's Online Privacy Protection Act (COPPA).

Valid values are:

• 0: Disables child-directed treatment.
• 1: Enables child-directed treatment.

Example:

ad.us_privacy

Identifies the viewer's privacy preference. This parameter is required for compliance with the California Consumer Privacy Act (CCPA).

Syntax:

Example:

ad.vad_type

Determines whether a linear or non-linear ad should be returned for the request. Valid values are:

Example:

ad.vid

Identifies the video content ID for the content currently being shown to the user. This ID is assigned by the CMS that hosts your content. In most cases, the video player will add this value to the ad tag dynamically, based on the editorial content.

ad.video_duration

Indicates the duration of the content in seconds.

Example:

ad.vip

Sets the viewer's IP address (IPv4) in the ad request.

Example:

Default value:

The request's remote IP address.

ad.vpi

Converts an ad rule request into an inline VMAP request.

Example:

ad.vpos

Indicates whether the ad request is being sent from pre-roll,mid-roll or post-roll.

Default value:

By default, this parameter is set to the asset's external ID. If an external ID has not been defined, then it is set to the asset ID.

Example:

ad.adUnit

ad.pmnd

[CORRELATOR]

[SCOR]