Ima de la clase
Funciones globales que controlan el IMA para PAL de Roku.
Clase ima.NonceLoader
Métodos
La biblioteca de acceso programático permite a los publicadores recopilar indicadores que se pueden usar para desbloquear la demanda de AdX. Para cada solicitud de anuncio, llama a los métodos set relevantes, según sea necesario, seguido de una llamada a loadNonceManager. Los editores pueden llamar a NonceManager.getNonce() para obtener la cadena que se debe agregar a las solicitudes de anuncios como el valor del
createNonceLoader()
Devuelve ima.NonceLoader
:
loadNonceManager(request)
Muestra ima.NonceManager
: Es un administrador de nonce que genera un nonce para una solicitud de anuncio.
Parámetro | Tipo | Descripción |
---|---|---|
request |
ima.NonceRequest |
Es la solicitud que contiene información sobre el nonce que se solicita. |
Clase ima.NonceManager
Métodos
Administra un nonce y sus informes de eventos para una sola sesión de reproducción de contenido.
Se debe llamar a los métodos del ciclo de vida de la sesión de reproducción de contenido, incluidos ima.NonceManager.sendAdClick
, ima.NonceManager.sendAdTouch
, ima.NonceManager.sendPlaybackStart
y sendPlaybackEnd
cuando ocurren estos eventos respectivos para habilitar la monetización programática.
getNonce()
Muestra String
: El nonce que se generó para este administrador cuando se cargó. Este
valor nunca cambiará para una instancia de NonceManager determinada. Este valor del nonce solo es válido para una única sesión de reproducción de contenido con una duración máxima de 6 horas.
poll()
Actualiza el estado de administrador para que pueda hacer un seguimiento del progreso de la reproducción.
sendAdClick()
Notifica a los servidores de anuncios de Google que se produjo un clic en un anuncio durante la sesión de reproducción de contenido determinada.
sendAdImpression()
Ya no está disponible. Usa ima.NonceManager.sendPlaybackStart
y 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.
Class
ima.NonceRequest
Fields
adWillAutoPlay,
adWillPlayMuted,
continuousPlayback,
descriptionUrl,
directedForChildOrUnknownAge,
iconsSupported,
ppid,
sessionId,
storageAllowed,
supportedApiFrameworks,
videoHeight,
videoWidth
Methods
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
: