Class: NonceRequest

NonceRequest

class   public

The NonceRequest is used to store information about the request for a nonce.

Constructor

NonceRequest

new NonceRequest()

Implements

WebNonceRequestInterface

Properties

adWillAutoPlay

(null or 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.

adWillPlayMuted

(null or boolean)

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

continuousPlayback

(null or 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.

descriptionUrl

Sets 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.

Parameter
descriptionUrl	string

Returns

void 

descriptionUrl

The description URL of the content during which the ad will be played.

Returns

string 

iconsSupported

boolean

Whether VAST icons are supported by the video player.

nonceLengthLimit

number

The length limit of the generated nonce. The loadNonceManager promise will be rejected if the nonce is longer than this limit. Defaults to the largest possible integer. Choosing a shorter length limit may cause various targeting properties to be excluded from the nonce.

omidPartnerName

Sets the name of the partner integrating OMID measurement. PAL ignores any partner name string longer than 200 characters and excludes it from the nonce.

The partner name must match the name supplied to the OM SDK for the ad session. For further details, see the OM SDK Onboarding Guide.

You must set both omidPartnerName and omidPartnerVersion to successfully include the omid_p= value in a nonce.

Parameter
omidPartnerName	string

Returns

void 

omidPartnerName

The name of the partner integrating OMID measurement.

Returns

string 

omidPartnerVersion

The version of the partner integrating OMID measurement. Any partner version string longer than 200 characters will be ignored and excluded from the nonce.

This must match the string supplied to the OM SDK for the ad session.

To successfully include the omid_p= value in a nonce, both this omidPartnerVersion and omidPartnerName must be set.

Parameter
omidPartnerVersion	string

Returns

void 

omidPartnerVersion

The version of the partner integrating OMID measurement.

Returns

string 

playerType

Sets the partner provided player type. This should be used to specify the name of the partner player. Any player type string longer than 200 characters will be ignored and excluded from the nonce.

Parameter
playerType	string

Returns

void 

playerType

The partner provided player type.

Returns

string 

playerVersion

Sets the partner provided player version. This should be used to specify the version of the partner player. Any player version string longer than 200 characters will be ignored and excluded from the nonce.

Parameter
playerVersion	string

Returns

void 

playerVersion

The partner provided player version.

Returns

string 

ppid

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

Parameter
ppid	string

Returns

void 

ppid

The publisher provided ID.

Returns

string 

sessionId

string

The session ID is a temporary random ID. It is used exclusively for frequency capping on connected TVs (smart TVs, game consoles, and set-top-boxes). A session ID must be a UUID.

supportedApiFrameworks

non-null Array of number

An array of supported API frameworks. These values are defined in the AdCOM 1.0 "API Frameworks" list. Example: [2, 7, 9] indicates this player supports VPAID 2.0, OMID 1.0, and SIMID 1.1.

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.

videoHeight

number

The height of the ad video element.

videoWidth

number

The width of the ad video element.