Interface PalNonceRequestParams

The parameters for Google PAL SDK to request for a nonce with.

interface PalNonceRequestParams {
    adWillAutoPlay?: boolean;
    adWillPlayMuted?: boolean;
    continuousPlayback?: boolean;
    descriptionUrl?: string;
    iconsSupported?: boolean;
    nonceLengthLimit?: number;
    omidPartnerName?: string;
    omidPartnerVersion?: string;
    playerType?: string;
    playerVersion?: string;
    ppid?: string;
    sessionId?: string;
    supportedApiFrameworks?: number[];
    url?: string;
    videoHeight?: number;
    videoWidth?: number;
}

Properties

adWillAutoPlay? adWillPlayMuted? continuousPlayback? descriptionUrl? iconsSupported? nonceLengthLimit? omidPartnerName? omidPartnerVersion? playerType? playerVersion? ppid? sessionId? supportedApiFrameworks? url? videoHeight? videoWidth?

Properties

Optional adWillAutoPlay

adWillAutoPlay?: boolean

Set to true if the ad will be auto played without waiting for user interaction. Set to false if the ad will wait for user interaction before being played.

Optional adWillPlayMuted

adWillPlayMuted?: boolean

Set to true if the ad will be played while muted. Set to false if the ad will play unmuted.

Optional continuousPlayback

continuousPlayback?: boolean

Set to true if the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist. Set to false otherwise.

Optional descriptionUrl

descriptionUrl?: string

The description URL of the content during which the ad will be played. Any description URL string longer than 500 characters will be ignored and excluded from the nonce.

Optional iconsSupported

iconsSupported?: boolean

Whether VAST icons are supported by the video player.

Optional nonceLengthLimit

nonceLengthLimit?: number

The length limit of the generated nonce. Defaults to the largest possible integer. Choosing a shorter length limit may cause various targeting properties to be excluded from the nonce.

Optional omidPartnerName

omidPartnerName?: string

The partner name assigned by IAB for integrating OMID measurement (the name that is supplied to the OM SDK for the ad session). Set this field to override the default. Any partner name string longer than 200 characters will be ignored and excluded from the nonce.

Default Value

(the partner name assigned to MediaTailor)

Optional omidPartnerVersion

omidPartnerVersion?: string

The version string of the OMID measurement integration (the version that is supplied to the OM SDK for the ad session), in semantic versioning format. Set this field to override the default. Any partner version string longer than 200 characters will be ignored and excluded from the nonce.

Default Value

(the latest version of the integration owned by MediaTailor)

Optional playerType

playerType?: string

Sets the player type. Any player type string longer than 200 characters will be ignored and excluded from the nonce.

Optional playerVersion

playerVersion?: string

Sets the player version. Any player version string longer than 200 characters will be ignored and excluded from the nonce.

Optional ppid

ppid?: string

The publisher provided ID. Any PPID longer than 200 characters will be ignored and excluded from the nonce.

Optional sessionId

sessionId?: string

A temporary random UUID. It is used exclusively for frequency capping on connected TVs (smart TVs, game consoles, and set-top-boxes). Set this field to override the default.

Default Value

(an automatically generated UUID)

Optional supportedApiFrameworks

supportedApiFrameworks?: number[]

A list of supported frameworks, each represented by a number. These numbers are defined in the AdCOM 1.0 "API Frameworks" list. Set this field to override the default.

Default Value

(the list of frameworks supported by MediaTailor)

Optional url

url?: string

The URL to which the ads will be targeted. By default, this is the same as the page that will display the ads, but it may be manually set.

Optional videoHeight

videoHeight?: number

The height of the ad video element.

Optional videoWidth

videoWidth?: number

The width of the ad video element.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc