Stay organized with collections
Save and categorize content based on your preferences.
NonceRequest
classpublic
The NonceRequest is used to store information about the request for a nonce.
Constructor
NonceRequest
new
NonceRequest()
Implements
NonceRequestInterface
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.
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. 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.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eNonceRequest\u003c/code\u003e class stores information about a request for a nonce, which is used for ad targeting and verification.\u003c/p\u003e\n"],["\u003cp\u003eIt includes various properties like ad behavior, content description, player details, and user session information.\u003c/p\u003e\n"],["\u003cp\u003eThese properties influence the generation of the nonce and its use in ad serving.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can configure properties such as ad autoplay, mute state, and continuous playback behavior to tailor the nonce request.\u003c/p\u003e\n"],["\u003cp\u003eThe nonce length can be limited, although this might affect the inclusion of certain targeting properties.\u003c/p\u003e\n"]]],["The `NonceRequest` class stores information for a nonce request. Key properties include: `adWillAutoPlay` and `adWillPlayMuted` (booleans for ad behavior), `continuousPlayback` (boolean for video play), `descriptionUrl`, `playerType`, `playerVersion`, `ppid`, `sessionId`, and `url` (strings for content and player details, with length limits), `iconsSupported` (boolean for VAST support), `nonceLengthLimit`(number for nonce limit), and `videoHeight` and `videoWidth` (numbers for ad dimensions). It manages nonce generation and validation, using provided IDs, URLs and player specs.\n"],null,["# Class: NonceRequest\n\nNonceRequest\n============\n\nclass public\n\nThe NonceRequest is used to store information about the request for a nonce.\n\nConstructor\n-----------\n\n### NonceRequest\n\nnew\nNonceRequest()\n\nImplements\n: NonceRequestInterface\n\nProperties\n----------\n\n### adWillAutoPlay\n\n(null or boolean)\n\nSet to true if the ad will be auto played without waiting for user\ninteraction. Set to false if the ad will wait for user interaction before\nbeing played.\n\n### adWillPlayMuted\n\n(null or boolean)\n\nSet to true if the ad will be played while muted. Set to false if the ad\nwill play unmuted.\n\n### continuousPlayback\n\n(null or boolean)\n\nSet to true if the player intends to continuously play the content videos\none after another similar to TV broadcast or video playlist. Set to false\notherwise.\n\n### descriptionUrl\n\n\u003cbr /\u003e\n\nSets the description URL of the content during which the ad will be played.\nAny description URL string longer than 500 characters will be ignored and\nexcluded from the nonce.\n\n| #### Parameter ||\n|----------------|--------|\n| descriptionUrl | string |\n\nReturns\n\n: `void`\n\n### descriptionUrl\n\n\u003cbr /\u003e\n\nThe description URL of the content during which the ad will be played.\n\nReturns\n\n: `string`\n\n### iconsSupported\n\nboolean\n\nWhether VAST icons are supported by the video player.\n\n### nonceLengthLimit\n\nnumber\n\nThe length limit of the generated nonce. The loadNonceManager promise\nwill be rejected if the nonce is longer than this limit. Defaults to the\nlargest possible integer. Choosing a shorter length limit may cause\nvarious targeting properties to be excluded from the nonce.\n\n### playerType\n\n\u003cbr /\u003e\n\nSets the partner provided player type. This should be used to specify the\nname of the partner player. Any player type string longer than 200\ncharacters will be ignored and excluded from the nonce.\n\n| #### Parameter ||\n|------------|--------|\n| playerType | string |\n\nReturns\n\n: `void`\n\n### playerType\n\n\u003cbr /\u003e\n\nThe partner provided player type.\n\nReturns\n\n: `string`\n\n### playerVersion\n\n\u003cbr /\u003e\n\nSets the partner provided player version. This should be used to specify\nthe version of the partner player. Any player version string longer than\n200 characters will be ignored and excluded from the nonce.\n\n| #### Parameter ||\n|---------------|--------|\n| playerVersion | string |\n\nReturns\n\n: `void`\n\n### playerVersion\n\n\u003cbr /\u003e\n\nThe partner provided player version.\n\nReturns\n\n: `string`\n\n### ppid\n\n\u003cbr /\u003e\n\nSets the publisher provided ID. Any PPID longer than 200 characters will be\nignored and excluded from the nonce.\n\n| #### Parameter ||\n|------|--------|\n| ppid | string |\n\nReturns\n\n: `void`\n\n### ppid\n\n\u003cbr /\u003e\n\nThe publisher provided ID.\n\nReturns\n\n: `string`\n\n### sessionId\n\nstring\n\nThe session ID is a temporary random ID. It is used exclusively for\nfrequency capping. A session ID must be a UUID.\n\n### url\n\nstring\n\nThe URL to which the ads will be targeted. By default, this is the same\nas the page that will display the ads, but it may be manually set.\n\n### videoHeight\n\nnumber\n\nThe height of the ad video element.\n\n### videoWidth\n\nnumber\n\nThe width of the ad video element."]]
