Class NonceRequest

Stores information about the request for a nonce.
Constructors
constructor
Properties
adWillAutoPlay
Set to a true value if the ad autoplays without waiting for user interaction, like clicking play.
adWillPlayMuted
Set to a true value if the ad plays while muted.
continuousPlayback
Set to a true value if the player plays the content videos continuously, like a video playlist.
descriptionUrl
The description URL of the content during which the ad plays.
iconsSupported
Deprecated. Whether the video player supports VAST icons.
nonceLengthLimit
The length limit of the generated nonce.
omidPartnerName
The name of the partner integrating Open Measurement Interface Definition (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 (PPID).
sessionId
A temporary, random ID for frequency capping on connected TVs, such as smart TVs, game consoles, and set-top-boxes.
skippablesSupported
Determines if the video player supports VAST skippable ads.
supportedApiFrameworks
An array of supported API frameworks.
url
The URL that 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 a true value if the ad autoplays without waiting for user interaction, like clicking play. Set to a false value if the ad waits for any user interaction to start playback.

adWillPlayMuted

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

continuousPlayback

continuousPlayback: boolean
Set to a true value if the player plays the content videos continuously, like a video playlist. Set to a false value otherwise.

descriptionUrl

descriptionUrl: string
The description URL of the content during which the ad plays. PAL ignores description URL strings longer than 500 characters and excludes the string from the nonce.

iconsSupported

iconsSupported: boolean
Whether the video player supports VAST icons.

nonceLengthLimit

nonceLengthLimit: number
The length limit of the generated nonce. If the nonce is longer than this limit, PAL rejects the loadNonceManager promise. Defaults to the largest possible integer. Choosing a shorter length limit might exclude NonceRequest instance properties from the nonce.

omidPartnerName

omidPartnerName: string
The name of the partner integrating Open Measurement Interface Definition (OMID) measurement. PAL ignores a partner name string longer than 200 characters and excludes the string from the nonce.

The partner name must match the name supplied to the OM SDK for the ad session. For details, see Open Measurement (OM) SDK.

To successfully include the omid_p= value in a nonce, you must set the omidPartnerVersion and omidPartnerName parameters.

omidPartnerVersion

omidPartnerVersion: string
The version of the partner integrating OMID measurement. PAL ignores a partner version string longer than 200 characters and excludes the string from the nonce.

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

To successfully include the omid_p= value in a nonce, you must set the omidPartnerVersion and omidPartnerName parameters.

playerType

playerType: string
The partner provided player type. To specify the partner player type, use this property. PAL ignores player type strings longer than 200 characters and excludes the string from the nonce.

playerVersion

playerVersion: string
The partner provided player version. To specify the partner player version, use this property. PAL ignores player version strings longer than 200 characters and excludes the string from the nonce.

ppid

ppid: string
The publisher provided ID (PPID). PAL ignores PPID values longer than 200 characters and excludes the value from the nonce.

sessionId

sessionId: string
A temporary, random ID for frequency capping on connected TVs, such as smart TVs, game consoles, and set-top-boxes. A session ID must be a UUID.

skippablesSupported

skippablesSupported: boolean
Determines if the video player supports VAST skippable ads.

supportedApiFrameworks

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

url

url: string
The URL that ads are targeting. By default, this URL is the same as the page that displays the ads, but you can set the URL manually.

videoHeight

videoHeight: number
The height of the ad video element.

videoWidth

videoWidth: number
The width of the ad video element.