Cette page a été traduite par l'API Cloud Translation.

Documentation de référence de l'API Roku du SDK PAL

Image du cours

Fonctions globales qui contrôlent l'IMA de Roku pour PAL

Classe ima.NonceLoader

Méthodes

La bibliothèque d'accès programmatique permet aux éditeurs de collecter des signaux qui peuvent être utilisés pour débloquer la demande AdX. Pour chaque demande d'annonce, appelez les setters pertinents selon les besoins, puis appelez loadNonceManager. Les éditeurs peuvent ensuite appeler NonceManager.getNonce() afin d'obtenir la chaîne à ajouter aux demandes d'annonces en tant que valeur du

`createNonceLoader()`

Renvoie ima.NonceLoader:

`loadNonceManager(request)`

Renvoie ima.NonceManager:gestionnaire de nonce permettant de générer un nonce pour une demande d'annonce.

Paramètres	Type	Description
`request`	`ima.NonceRequest`	Requête contenant des informations sur le nonce demandé.

Haut de page

Classe ima.NonceManager

Méthodes

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

Gère un nonce et ses rapports sur les événements pour une seule session de lecture de contenu. Les méthodes du cycle de vie de la session de lecture de contenu, y compris ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart et sendPlaybackEnd, doivent être appelées lorsque ces événements respectifs se produisent afin d'activer la monétisation programmatique.

`getNonce()`

Renvoie String:nonce généré pour ce gestionnaire lors de son chargement. Cette valeur ne sera jamais modifiée pour une instance NonceManager donnée. Cette valeur nonce n'est valide que pour une seule session de lecture de contenu pour une durée maximale de 6 heures.

`poll()`

Met à jour l'état du gestionnaire afin qu'il puisse suivre la progression de la lecture.

`sendAdClick()`

Notifie les serveurs publicitaires Google qu'un clic sur une annonce s'est produit pendant la session de lecture de contenu donnée.

`sendAdImpression()`

Obsolète. Utiliser ima.NonceManager.sendPlaybackStart et 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

Documentation de référence de l'API Roku du SDK PAL

Image du cours

Classe ima.NonceLoader

`createNonceLoader()`

`loadNonceManager(request)`

Classe ima.NonceManager

`getNonce()`

`poll()`

`sendAdClick()`

`sendAdImpression()`

`sendAdTouch(touch)`

`sendPlaybackEnd()`

`sendPlaybackStart()`

Class ima.NonceRequest

Properties

`createNonceRequest()`

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.