Stay organized with collections
Save and categorize content based on your preferences.
NonceManager
classpublic
Manages a nonce and its event reporting for a single content playback
session.
The content playback session lifecycle methods, including sendAdClick,
sendTouch, sendPlaybackStart, and sendPlaybackEnd must be called as
these respective events occur in order to enable programmatic monetization.
Methods
getNonce
public
getNonce() returns string
Returns
string The nonce generated for this manager when it was loaded.
This value will never change for a given NonceManager instance. This nonce value is only valid for a single content playback session up to a maximum duration of 6 hours.
sendAdClick
public
sendAdClick() returns void
Notifies Google ad servers that a clickthrough on an ad has occurred during
the given content playback session.
Returns
void
sendAdImpression
public
sendAdImpression() returns void
Should be called when the first frame of the ad that was requested with
the nonce generated by this manager is displayed.
Deprecated
Use `sendPlaybackStart` and `sendPlaybackEnd` instead.
Returns
void
sendAdTouch
public
sendAdTouch(userInteractionEvent) returns void
Notifies Google ad servers that a user touch or click on the ad other than
a clickthrough (e.g. skip, mute, tap, etc.) has occurred during the given
content playback session.
Parameter
userInteractionEvent
cast.framework.events.Event
The user interaction event fired by the Cast framework.
Value must not be null.
Returns
void
sendPlaybackEnd
public
sendPlaybackEnd() returns void
Notifies Google ad servers that playback for the given content playback
session has ended. This should be called when playback ends (e.g. when the
player reaches end of stream, or when the user exits playback mid-way, or
when the user leaves the page, or when advancing to the next content item
in a playlist setting).
This method ends the asynchronous calls to Google servers started in
sendPlaybackStart.
Returns
void
sendPlaybackStart
public
sendPlaybackStart() returns void
Notifies Google ad servers that playback for the given content playback
session has started. This should be called on "video player start". This
may be in response to a user-initiated action (click-to-play) or a page
initiated action (autoplay).
This method will start asynchronous calls to Google servers to collect
signals needed for IVT monitoring and detection.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThe NonceManager class manages a unique nonce and reports events for a single content playback session, enabling programmatic monetization.\u003c/p\u003e\n"],["\u003cp\u003eTo enable programmatic monetization, you must call specific lifecycle methods like \u003ccode\u003esendAdClick\u003c/code\u003e, \u003ccode\u003esendTouch\u003c/code\u003e, \u003ccode\u003esendPlaybackStart\u003c/code\u003e, and \u003ccode\u003esendPlaybackEnd\u003c/code\u003e when their corresponding events occur.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetNonce()\u003c/code\u003e provides a unique nonce for the session, valid for a single playback up to 6 hours.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esendPlaybackStart()\u003c/code\u003e and \u003ccode\u003esendPlaybackEnd()\u003c/code\u003e should be used to signal the start and end of content playback to Google ad servers, replacing the deprecated \u003ccode\u003esendAdImpression\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eOther methods like \u003ccode\u003esendAdClick\u003c/code\u003e and \u003ccode\u003esendAdTouch\u003c/code\u003e allow reporting of ad interactions for comprehensive monetization tracking.\u003c/p\u003e\n"]]],["The `NonceManager` class manages a unique nonce for a single content playback session, valid for up to 6 hours. Key actions include: retrieving the nonce via `getNonce()`; notifying ad server events with `sendAdClick()`, `sendAdTouch()`, and `sendAdImpression()`; and signaling the start and end of a playback session via `sendPlaybackStart()` and `sendPlaybackEnd()`. `sendPlaybackStart()` begins background monitoring while `sendPlaybackEnd()` concludes it.\n"],null,["# Class: NonceManager\n\nNonceManager\n============\n\nclass public\n\nManages a nonce and its event reporting for a single content playback\nsession.\nThe content playback session lifecycle methods, including `sendAdClick`,\n`sendTouch`, `sendPlaybackStart`, and `sendPlaybackEnd` must be called as\nthese respective events occur in order to enable programmatic monetization.\n\nMethods\n-------\n\n### getNonce\n\npublic\n\ngetNonce() returns string\n\nReturns\n\n: `string` The nonce generated for this manager when it was loaded.\n This value will never change for a given `NonceManager` instance. This nonce value is only valid for a single content playback session up to a maximum duration of 6 hours.\n\n### sendAdClick\n\npublic\n\nsendAdClick() returns void\n\nNotifies Google ad servers that a clickthrough on an ad has occurred during\nthe given content playback session.\n\nReturns\n\n: `void`\n\n### sendAdImpression\n\npublic\n\nsendAdImpression() returns void\n\nShould be called when the first frame of the ad that was requested with\nthe nonce generated by this manager is displayed.\n\nDeprecated\n: Use \\`sendPlaybackStart\\` and \\`sendPlaybackEnd\\` instead.\n\nReturns\n\n: `void`\n\n### sendAdTouch\n\npublic\n\nsendAdTouch(userInteractionEvent) returns void\n\nNotifies Google ad servers that a user touch or click on the ad other than\na clickthrough (e.g. skip, mute, tap, etc.) has occurred during the given\ncontent playback session.\n\n| #### Parameter ||\n|----------------------|-------------------------------------------------------------------------------------------------------------|\n| userInteractionEvent | cast.framework.events.Event The user interaction event fired by the Cast framework. Value must not be null. |\n\nReturns\n\n: `void`\n\n### sendPlaybackEnd\n\npublic\n\nsendPlaybackEnd() returns void\n\nNotifies Google ad servers that playback for the given content playback\nsession has ended. This should be called when playback ends (e.g. when the\nplayer reaches end of stream, or when the user exits playback mid-way, or\nwhen the user leaves the page, or when advancing to the next content item\nin a playlist setting).\n\nThis method ends the asynchronous calls to Google servers started in\n`sendPlaybackStart`.\n\nReturns\n\n: `void`\n\n### sendPlaybackStart\n\npublic\n\nsendPlaybackStart() returns void\n\nNotifies Google ad servers that playback for the given content playback\nsession has started. This should be called on \"video player start\". This\nmay be in response to a user-initiated action (click-to-play) or a page\ninitiated action (autoplay).\n\nThis method will start asynchronous calls to Google servers to collect\nsignals needed for IVT monitoring and detection.\n\nReturns\n\n: `void`"]]
