หน้านี้ได้รับการแปลโดย Cloud Translation API

ข้อมูลอ้างอิงเกี่ยวกับ Roku API สำหรับ PAL SDK

คลาส ima

ฟังก์ชันส่วนกลางที่ควบคุม Roku IMA สำหรับ PAL

คลาส ima.NonceLoader

เมธอด

ไลบรารีการเข้าถึงแบบเป็นโปรแกรมช่วยให้ผู้เผยแพร่โฆษณาสามารถรวบรวมสัญญาณที่สามารถใช้เพื่อปลดล็อกดีมานด์ของ AdX สำหรับคำขอโฆษณาแต่ละรายการ ให้เรียกตัวตั้งค่าที่เกี่ยวข้องตามที่จำเป็น ตามด้วยการเรียกloadNonceManager จากนั้นผู้เผยแพร่โฆษณาสามารถเรียกใช้ NonceManager.getNonce() เพื่อรับสตริงที่ควรเพิ่มลงในคำขอโฆษณาเป็นค่าสำหรับ

`createNonceLoader()`

ส่งคืน ima.NonceLoader:

`loadNonceManager(request)`

แสดงผล ima.NonceManager: ผู้จัดการ Nonce สำหรับสร้าง Nonce สำหรับคำขอโฆษณา

พารามิเตอร์	Type	คำอธิบาย
`request`	`ima.NonceRequest`	คำขอที่มีข้อมูลเกี่ยวกับค่าที่ได้จากการสอบถาม

กลับไปด้านบน

คลาส ima.NonceManager

เมธอด

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

จัดการ Noce และการรายงานเหตุการณ์สำหรับเซสชันการเล่นเนื้อหาเดียว ต้องเรียกใช้วิธีการของวงจรการเล่นเนื้อหา ซึ่งรวมถึง ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart และ sendPlaybackEnd เมื่อเกิดเหตุการณ์ที่เกี่ยวข้องเหล่านี้ขึ้นเพื่อเปิดใช้การสร้างรายได้แบบเป็นโปรแกรม

`getNonce()`

แสดงผล String: ค่า Noce ที่สร้างขึ้นสำหรับบัญชีดูแลจัดการนี้เมื่อโหลด ค่านี้จะไม่เปลี่ยนแปลงสำหรับอินสแตนซ์ NonceManager ที่ระบุ ค่า Nonce นี้ใช้ได้สำหรับเซสชันการเล่นเนื้อหารายการเดียวเท่านั้นโดยมีระยะเวลาสูงสุด 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

ข้อมูลอ้างอิงเกี่ยวกับ Roku API สำหรับ PAL SDK

คลาส 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.