דף זה תורגם על ידי Cloud Translation API.

חומרי עזר ל-PAL SDK Roku API

ima Class

פונקציות גלובליות לשליטה ב-IMA IMA ל-PAL.

Class ima.NonceLoader

שיטות

ספריית הגישה הפרוגרמטית מאפשרת לבעלי תוכן דיגיטלי לאסוף אותות שניתן להשתמש בהם כדי לקבל גישה לביקוש ב-AdX. עבור כל בקשה להצגת מודעה, קוראים למגדירים הרלוונטיים לפי הצורך ולאחר מכן קריאה ל-loadNonceManager. לאחר מכן בעלי אתרים יכולים לקרוא ל-NonceManager.getNonce() כדי לקבל את המחרוזת שיש להוסיף לבקשות להצגת מודעות כערך

`createNonceLoader()`

מחזיר את ima.NonceLoader:

`loadNonceManager(request)`

מחזירה ima.NonceManager: מנהל חד-פעמי ליצירת חד-פעמי (nonce) עבור בקשה להצגת מודעה.

פרמטר	סוג	תיאור
`request`	`ima.NonceRequest`	הבקשה מכילה מידע על ה-nonce.

חזרה למעלה

Class ima.NonceManager

שיטות

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

ניהול דיווח חד-פעמי ואת הדיווח על אירועים עבור סשן יחיד של הפעלת תוכן. צריך להפעיל את השיטות במחזור החיים של סשן הפעלת התוכן, כולל ima.NonceManager.sendAdClick, ima.NonceManager.sendAdTouch, ima.NonceManager.sendPlaybackStart וגם sendPlaybackEnd מאחר שהאירועים המתאימים מתרחשים כדי להפעיל מונטיזציה פרוגרמטית.

`getNonce()`

מחזירה String: הערך החד-פעמי (nonce) שנוצר לחשבון הניהול הזה בזמן הטעינה. הערך הזה אף פעם לא ישתנה במכונה נתונה של 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

חומרי עזר ל-PAL SDK Roku API

ima Class

Class ima.NonceLoader

`createNonceLoader()`

`loadNonceManager(request)`

Class 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.