The NonceRequest is used to store information about the request for a nonce.
| Constructors | |
|---|---|
constructor
|
|
| Properties | |
|---|---|
ad
|
Set to true if the ad auto play without waiting for user interaction.
|
ad
|
Set to true if the ad play while muted. |
continuous
|
Set to true if the player intends to continuously play the content videos one after
another similar to TV broadcast or video playlist.
|
description
|
The description URL of the content during which the ad plays. |
icons
|
Whether VAST icons are supported by the video player. |
nonce
|
The length limit of the generated nonce. |
omid
|
The name of the partner integrating OMID measurement. |
omid
|
The version of the partner integrating OMID measurement. |
player
|
The partner provided player type. |
player
|
The partner provided player version. |
ppid
|
The publisher provided ID. |
session
|
The session ID is a temporary random ID. |
supported
|
An array of supported API frameworks. |
url
|
The URL to which the ads are targeting. |
video
|
The height of the ad video element. |
video
|
The width of the ad video element. |
Constructors
constructor
new NonceRequest(): NonceRequest
| Returns | |
|---|---|
NonceRequest
|
|
Properties
adWillAutoPlay
adWillAutoPlay: boolean
adWillPlayMuted
adWillPlayMuted: boolean
continuousPlayback
continuousPlayback: boolean
descriptionUrl
descriptionUrl: string
iconsSupported
iconsSupported: boolean
nonceLengthLimit
nonceLengthLimit: number
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 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
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
playerVersion
playerVersion: string
ppid
ppid: string
sessionId
sessionId: string
supportedApiFrameworks
supportedApiFrameworks: number[]
[2, 7, 9] indicates this player
supports VPAID 2.0, OMID 1.0, and SIMID 1.1.
url
url: string
videoHeight
videoHeight: number
videoWidth
videoWidth: number