NonceRequest

new NonceRequest()

Implements

NonceRequestInterface

adWillAutoPlay

nullable 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

nullable boolean

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

continuousPlayback

nullable 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

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.

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.

playerType

string

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.

playerVersion

string

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.

ppid

string

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

sessionId

string

The session ID is a temporary random ID. It is used exclusively for frequency capping. A session ID must be a UUID.

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.