Class NonceRequest

The NonceRequest is used to store information about the request for a nonce.
Constructors
constructor
Properties
adWillAutoPlay
Set to true if the ad auto play without waiting for user interaction.
adWillPlayMuted
Set to true if the ad play while muted.
continuousPlayback
Set to true if the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.
descriptionUrl
The description URL of the content during which the ad plays.
iconsSupported
Whether VAST icons are supported by the video player.
nonceLengthLimit
The length limit of the generated nonce.
omidPartnerName
The name of the partner integrating OMID measurement.
omidPartnerVersion
The version of the partner integrating OMID measurement.
playerType
The partner provided player type.
playerVersion
The partner provided player version.
ppid
The publisher provided ID.
sessionId
The session ID is a temporary random ID.
supportedApiFrameworks
An array of supported API frameworks.
url
The URL to which the ads are targeting.
videoHeight
The height of the ad video element.
videoWidth
The width of the ad video element.

Constructors

constructor

new NonceRequest(): NonceRequest
Returns
NonceRequest

Properties

adWillAutoPlay

adWillAutoPlay: boolean
Set to true if the ad auto play without waiting for user interaction. Set to false if the ad waits for user interaction to start playback.

adWillPlayMuted

adWillPlayMuted: boolean
Set to true if the ad play while muted. Set to false if the ad plays unmuted.

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.

descriptionUrl

descriptionUrl: string
The description URL of the content during which the ad plays. Any description URL string longer than 500 characters is ignored and excluded from the nonce.

iconsSupported

iconsSupported: boolean
Whether VAST icons are supported by the video player.

nonceLengthLimit

nonceLengthLimit: number
The length limit of the generated nonce. The loadNonceManager promise is 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

omidPartnerName: string
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.

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

omidPartnerVersion

omidPartnerVersion: string
The version of the partner integrating OMID measurement. Any partner version string longer than 200 characters is 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.

playerType

playerType: string
The partner provided player type. Use this property to specify the name of the partner player. Any player type string longer than 200 characters is ignored and excluded from the nonce.

playerVersion

playerVersion: string
The partner provided player version. Use this property to specify the version of the partner player. Any player version string longer than 200 characters is ignored and excluded from the nonce.

ppid

ppid: string
The publisher provided ID. Any PPID longer than 200 characters is ignored and excluded from the nonce.

sessionId

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

supportedApiFrameworks: 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

url: string
The URL to which the ads are targeting. By default, this is the same as the page that displays the ads, but it may be set manually.

videoHeight

videoHeight: number
The height of the ad video element.

videoWidth

videoWidth: number
The width of the ad video element.