このページは Cloud Translation API によって翻訳されました。

PAL SDK Roku API リファレンス

クラス ima

Roku IMA for PAL を制御するグローバル関数。

クラス ima.NonceLoader

メソッド

プログラマティックアクセスライブラリを使用すると、AdX の需要を喚起するために使用できるシグナルを収集できます。広告リクエストごとに、必要に応じて関連するセッターを呼び出し、その後に loadNonceManager を呼び出します。パブリッシャーは NonceManager.getNonce() を呼び出して、広告リクエストに追加する文字列を

`createNonceLoader()`

ima.NonceLoader を返します。

`loadNonceManager(request)`

戻り値 ima.NonceManager: 広告リクエストに対してノンスを生成するノンスマネージャー。

パラメータ	タイプ	説明
`request`	`ima.NonceRequest`	リクエストされたノンスに関する情報を含むリクエスト。

トップへ戻る

クラス ima.NonceManager

メソッド

getNonce、poll、sendAdClick、sendAdImpression、sendAdTouch、sendPlaybackEnd、sendPlaybackStart

単一のコンテンツ再生セッションのノンスとそのイベントレポートを管理します。プログラムによる収益化を有効にするには、ima.NonceManager.sendAdClick、ima.NonceManager.sendAdTouch、ima.NonceManager.sendPlaybackStart、sendPlaybackEnd などのコンテンツ再生セッションのライフサイクルメソッド（これらのイベントが発生するため）を呼び出す必要があります。

`getNonce()`

戻り値 String: 読み込み時にこのマネージャーに対して生成されたノンス。この値は、特定の NonceManager インスタンスに対して変更されることはありません。このノンス値は、最長 6 時間までの単一のコンテンツ再生セッションに対してのみ有効です。

`poll()`

マネージャーの状態を更新して、再生の進行状況を追跡できるようにします。

`sendAdClick()`

特定のコンテンツ再生セッション中に広告のクリックが発生したことを Google 広告サーバーに通知します。

`sendAdImpression()`

非推奨です。ima.NonceManager.sendPlaybackStart と 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

PAL SDK Roku API リファレンス

クラス ima

クラス ima.NonceLoader

`createNonceLoader()`

`loadNonceManager(request)`

クラス 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.