Riferimento API Roku SDK PAL

Avviso:l'SDK PAL per Roku è stato deprecato e le nuove applicazioni Roku che implementano l'SDK PAL per Roku non sono più certificate da Roku per la pubblicazione. Il supporto precedente dell'SDK PAL per Roku terminerà il 7 maggio 2025. Per saperne di più sull'invio di segnali GAM per Roku, contatta il rappresentante del tuo account.

1. 1. IMMA
   2. ima.NonceLoader
   3. ima.NonceManager
   4. ima.NonceRequest

Class ima

Funzioni globali che controllano Roku IMA per PAL.

Torna all'inizio

Classe ima.NonceLoader

Metodi

createNonceLoader, loadNonceManager

La libreria di accesso programmatico consente ai publisher di raccogliere indicatori da utilizzare per sbloccare la domanda AdX. Per ogni richiesta di annuncio, chiama i setter pertinenti, se necessario, e poi una chiamata a loadNonceManager. I publisher possono quindi chiamare NonceManager.getNonce() per ottenere la stringa da aggiungere alle richieste di annunci come valore

createNonceLoader()

Restituisci ima.NonceLoader:

loadNonceManager(request)

Restituisci ima.NonceManager: un gestore nonce per generare un nonce per una richiesta di annuncio.

Parametro	Tipo	Descrizione
request	ima.NonceRequest	La richiesta contenente informazioni sul nonce richiesto.

Torna all'inizio

Classe ima.NonceManager

Metodi

getNonce, poll, sendAdClick, sendAdImpression, sendAdTouch, sendPlaybackEnd, sendPlaybackStart

Gestisce un nonce e i relativi report sugli eventi per una singola sessione di riproduzione dei contenuti. I metodi del ciclo di vita della sessione di riproduzione dei contenuti, tra cui ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart e sendPlaybackEnd, devono essere richiamati quando si verificano questi rispettivi eventi per abilitare la monetizzazione programmatica.

getNonce()

Restituisci String: il nonce generato per questo gestore al momento del caricamento. Questo valore non cambierà mai per una determinata istanza NonceManager. Questo valore nonce è valido solo per una singola sessione di riproduzione di contenuti fino a una durata massima di 6 ore.

poll()

Consente di aggiornare lo stato del gestore, in modo che possa tenere traccia dell'avanzamento della riproduzione.

sendAdClick()

Comunica agli ad server di Google che si è verificato un clickthrough su un annuncio durante la sessione di riproduzione dei contenuti specificata.

sendAdImpression()

Deprecato. Utilizza ima.NonceManager.sendPlaybackStart e ima.NonceManager.sendPlaybackEnd/code>.


sendAdTouch(touch)

Notifies Google ad servers that a user touch or click on the ad other than a clickthrough (for example, skip, mute, tap, etc.) has occurred during the given content playback session.

Parameter	Type	Description
touch	roInputEvent|String	The key received from onKeyEvent (if using SceneGraph), or the roInputEvent otherwise.

sendPlaybackEnd()

Notifies Google ad servers that playback for the given content playback session has ended. This should be called when playback ends (for example, when the player reaches end of stream, or when the user exits playback mid-way, or when the user quits the channel, 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()

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 channel initiated action (autoplay). This method will start asynchronous calls to Google servers to collect signal needed for IVT monitoring and detection.

Back to top

Class ima.NonceRequest

Fields

adWillAutoPlay, adWillPlayMuted, continuousPlayback, descriptionUrl, directedForChildOrUnknownAge, iconsSupported, ppid, sessionId, storageAllowed, supportedApiFrameworks, videoHeight, videoWidth

Methods

createNonceRequest

Information a publisher can provide when requesting a PAL nonce.

Properties

Name	Type	Description
adWillAutoPlay		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		Set to true if the ad will be played while muted. Set to false if the ad will play unmuted.
continuousPlayback		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		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.
directedForChildOrUnknownAge		Whether the ad request is directed to a child or user of an unknown age (TFCD or TFUA). Default value is false.
iconsSupported		Whether VAST icons are supported by the video player. On Roku this value should always be false.
ppid		The publisher provided ID. Any PPID longer than 200 characters will be ignored. Note: The PPID will not be used in personalisation. If it is appropriate to use a ppid for personalization, include it separately in clear text in your ad request.
sessionId		Session ID is a temporary random ID. It is used exclusively for frequency capping. A session ID must be a UUID.
storageAllowed		Whether storage consent (purpose 1 consent) from the IAB TCF V2 spec has been granted by the user. Defaults to true.
supportedApiFrameworks		Accepts an array of strings representing API framweworks supported by the player as defined in AdCOM 1.0 "API Frameworks" list https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-. Example: ["2","7","9"] indicates this player supports VPAID 2.0, OMID 1.0, and SIMID 1.1.
videoHeight		The height of the ad video element.
videoWidth		The width of the ad video element.

createNonceRequest()

Returns ima.NonceRequest:

Back to top