NonceManager
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
getNonce() returns string
- Returns
-
stringThe nonce generated for this manager when it was loaded. This value will never change for a givenNonceManagerinstance. This nonce value is only valid for a single content playback session up to a maximum duration of 6 hours.
sendAdClick
sendAdClick()
Notifies Google ad servers that a clickthrough on an ad has occurred during the given content playback session.
sendAdImpression
sendAdImpression()
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.
sendAdTouch
sendAdTouch(userInteractionEvent)
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. |
sendPlaybackEnd
sendPlaybackEnd()
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.
sendPlaybackStart
sendPlaybackStart()
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.