Referência da API Roku do SDK PAL

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

Classe ima

Funções globais que controlam Roku IMA para PAL.

Voltar ao início

Classe ima.NonceLoader

Métodos

createNonceLoader, loadNonceManager

A biblioteca de acesso programático permite que os editores coletem indicadores que podem ser usados para desbloquear a demanda do AdX. Para cada solicitação de anúncio, chame os setters relevantes, conforme necessário, seguidos por uma chamada para loadNonceManager. Os editores podem chamar NonceManager.getNonce() para obter a string que deve ser adicionada às solicitações de anúncios como o valor para o

createNonceLoader()

Retorna ima.NonceLoader:

loadNonceManager(request)

Retorna ima.NonceManager: um administrador de valor de uso único para gerar um valor de uso único para uma solicitação de anúncio.

Parâmetro	Tipo	Descrição
request	ima.NonceRequest	A solicitação contendo informações sobre o valor de uso único que está sendo solicitado.

Voltar ao início

Classe ima.NonceManager

Métodos

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

Gerencia um valor de uso único e os relatórios de eventos dele para uma única sessão de reprodução de conteúdo. Os métodos do ciclo de vida da sessão de reprodução de conteúdo, incluindo ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart e sendPlaybackEnd, precisam ser chamados à medida que esses respectivos eventos ocorrem para ativar a monetização programática.

getNonce()

Retorna String: o valor de uso único gerado para esse administrador quando ele foi carregado. Esse valor nunca muda para uma determinada instância do NonceManager. Esse valor de uso único é válido somente para uma única sessão de reprodução de conteúdo até uma duração máxima de seis horas.

poll()

Atualiza o estado do gerenciador para que ele possa acompanhar o progresso da reprodução.

sendAdClick()

Notifica os servidores de anúncios do Google de que um clique em um anúncio ocorreu durante a sessão de reprodução de conteúdo em questão.

sendAdImpression()

Obsoleto. Usar 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