ima Class
שיטות
פונקציות גלובליות לשליטה ב-IMA SDK.
disableLogging()
ההגדרה משביתה את הרישום ביומן ה-SDK. הרישום ביומן יופעל כברירת מחדל.
getStreamManager()
מחזירה מנהל זרם, אם הוא זמין.
אם מנהל השידור עדיין לא זמין, מוחזר לא חוקי.
במקרה שאירעה שגיאה ביצירת מנהל השידור, יוחזר אובייקט שגיאה.
מחזיר את הערך object
: מנהל השידור או אובייקט השגיאה.
initSdk(settings)
מפעיל את ה-SDK.
פרמטר | סוג | תיאור |
---|---|---|
settings |
object |
אובייקט אופציונלי להגדרות IMA. |
requestStream(streamRequest)
מפעיל בקשת זרם אסינכרוני
ה-Control חוזר לנגן מיד אחרי הקריאה לשיטה זו.
מחזירה את הערך object
: שגיאה או ערך לא תקין אם אין שגיאה
פרמטר | סוג | תיאור |
---|---|---|
streamRequest |
object |
Class ima.AdBreakInfo
שדות
שיטות
מכילה מידע על הפסקה למודעה. מועבר אל קריאות חוזרות לאירועים על ידי ה-SDK.
תכונות
שם | סוג | תיאור |
---|---|---|
adPosition |
|
האינדקס של המודעה בהפסקות למודעות. יהיה 1 עבור מודעות עצמאיות. |
duration |
|
משך ההפסקה המקסימלי בשניות, או -1 אם לא ידוע. |
podIndex |
|
בשידורים חיים, תמיד מוחזר 1-. עבור וידאו על פי דרישה (VOD), מחזיר את האינדקס של רצף המודעות. לרצף קדם-סרטון, הפונקציה מחזירה 0. למודעות באמצע סרטון, האפשרות מחזירה 1, 2, ..., n. לרצף פוסטים, הפונקציה מחזירה n+1...n+x. ערך ברירת המחדל הוא 0 אם המודעה הזו אינה חלק מ-pod, או אם ה-רצף אינו חלק מפלייליסט. |
timeOffset |
|
מיקום רצף התוכן בתוכן בשניות. מודעות לפני סרטון מחזירות 0, מודעה בסוף סרטון מחזירה 1- ומודעות באמצע סרטון מחזירות את הזמן שנקבע לרצף. |
totalAds |
|
המספר הכולל של המודעות שכלולות בהפסקה הזו למודעות. יהיה 1 עבור מודעות עצמאיות. |
createAdBreakInfo()
מחזיר את ima.AdBreakInfo
:
Class ima.AdEvent
שדות
אירועים שהופעלו על ידי מנהל המודעות.
תכונות
שם | סוג | תיאור |
---|---|---|
AD_PERIOD_ENDED |
|
מופעל בכל פעם שהשידור עובר מפרסום או צפחה לתוכן. הקטע הזה יופעל גם כשהמודעה מופעלת בפעם השנייה, או במהלך חיפוש למודעה. |
AD_PERIOD_STARTED |
|
מופעל בכל פעם שהשידור עובר מתוכן לפרסום או לתוכן צפחה. הקטע הזה יופעל גם כשהמודעה מופעלת בפעם השנייה, או במהלך חיפוש למודעה. |
COMPLETE |
|
מופעל כשההצגה של המודעה מסתיימת. |
ERROR |
|
מופעל כשמתרחשת שגיאה. |
FIRST_QUARTILE |
|
מופעל כשסמן המיקום של המודעה חוצה את הרבעון הראשון. |
MIDPOINT |
|
מופעל כשסמן המיקום של המודעה חוצה את נקודת האמצע. |
PROGRESS |
|
מופעל כאשר יש עדכון להתקדמות של מודעה. |
SKIPPABLE_STATE_CHANGED |
|
מופעל כשמצב מודעה שניתן לדלג עליה משתנה. |
SKIPPED |
|
מופעל כשהמשתמש מדלג על מודעה. |
START |
|
מופעל כשמודעה מתחילה לפעול. |
THIRD_QUARTILE |
|
מופעל כשסמן המיקום של המודעה חוצה את הרבעון השלישי. |
Class ima.AdInfo
שדות
שיטות
מכילה מידע על מודעה. מועבר אל קריאות חוזרות לאירועים על ידי ה-SDK.
תכונות
שם | סוג | תיאור |
---|---|---|
adBreakInfo |
|
מידע שקשור להפסקה המלאה שבה מופיעה המודעה הזו. |
adDescription |
|
תיאור המודעה. |
adId |
|
מזהה המודעה או מחרוזת ריקה אם היא לא ידועה. |
adSystem |
|
מערכת המודעות שמספקת את הקריאייטיב. |
adTitle |
|
הכותרת של המודעה. |
advertiserName |
|
שם המפרסם כפי שהוגדר על ידי הצד שמציג את הצגת המודעות. |
companions |
|
המודעות הנלוות שצוינו בתגובת ה-VAST. |
currentTime |
|
הזמן הנוכחי בתוך מודעה בשניות או -1 אם הוא לא ידוע. |
duration |
|
משך המודעה הבודדת בשניות או -1 אם לא ידוע. |
universalAdIDRegistry |
|
מחרוזת המשמשת לזיהוי כתובת ה-URL של אתר המרשם, שבו מסווג מזהה הפרסום האוניברסלי של הקריאייטיב שנבחר. |
universalAdIDValue |
|
המזהה האוניברסלי של הקריאייטיב שנבחר למודעה. |
wrappers |
|
מערך של ima.WrapperInfo עם מידע wrapper למודעה הזו. הסדר יהיה בין wrapper חיצוני לפנים |
createAdInfo()
מחזיר את ima.AdInfo
:
Class ima.Companion
שדות
שיטות
מכילה מידע על המודעות הנלוות למודעה.
תכונות
שם | סוג | תיאור |
---|---|---|
apiFramework |
|
ממשק ה-API הנדרש להפעלת המודעה הזו, או לא חוקי אם הוא לא זמין. |
creativeType |
|
מייצג את סוג הקריאייטיב בדרך כלל mimetype. |
height |
|
גובה המודעה הנלווית בפיקסלים. 0 אם האפשרות לא זמינה. |
trackingEvents |
|
מפה של אירועי מעקב שבהם המפתח הוא האירוע והערך הוא רשימה של כתובות URL שיש לשלוח אליהן פינג לאותו אירוע. |
url |
|
כתובת ה-URL של המשאב הסטטי של המודעה הנלווית הזו. |
width |
|
רוחב המודעה הנלווית בפיקסלים. 0 אם האפשרות לא זמינה. |
createCompanion()
מחזיר את ima.Companion
:
Class ima.CuePoint
שדות
שיטות
מכילה מידע על נקודת סימון.
תכונות
שם | סוג | תיאור |
---|---|---|
end |
|
שעת הסיום של נקודת סימון בשניות. הערך הזה מייצג הפסקה למודעה. |
hasPlayed |
|
ערך בוליאני שמציין שנקודת הרמז כבר הופעלה. |
start |
|
שעת ההתחלה של נקודת סימון בשניות. הערך הזה מייצג הפסקה למודעה. |
createCuePoint()
מחזיר את ima.CuePoint
:
Class ima.Error
שדות
שיטות
האובייקט מועבר לטיפול בשגיאות אם יש שגיאה.
תכונות
שם | סוג | תיאור |
---|---|---|
id |
|
המזהה של השגיאה. לרשימת קודי השגיאה, עיין ב קבוע ErrorEvent. |
info |
|
מידע נוסף על השגיאה. |
type |
|
הערך תמיד מוגדר ל'שגיאה' כדי לציין את סוג האובייקט הזה. |
createError()
מחזיר את ima.Error
:
מחלקה ima.ErrorEvent
שדות
כל השגיאות שה-SDK עשוי להחזיר.
תכונות
שם | סוג | תיאור |
---|---|---|
BAD_STREAM_REQUEST |
|
בקשת השידור לא אוכלסה בצורה נכונה. |
COULD_NOT_LOAD_STREAM |
|
לא ניתן היה לטעון את עדכוני התוכן. |
ERROR |
|
שגיאה לא ידועה. |
INVALID_RESPONSE |
|
תגובת השרת לא הייתה חוקית. |
STREAM_API_KEY_NOT_VALID |
|
השרת לא קיבל את מפתח ה-API שסופק. |
Class ima.Player
שיטות
adBreakEnded(adBreakInfo)
זה שינוי אופציונלי. זוהתה כשהסתיימה ההפסקה למודעה.
פרמטר | סוג | תיאור |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
מכילה מידע על ההפסקה למודעה. |
adBreakStarted(adBreakInfo)
זה שינוי אופציונלי. היא מתקבלת כשמתחילה הפסקה למודעה.
פרמטר | סוג | תיאור |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
מכילה מידע על ההפסקה למודעה. |
allVideoComplete()
זה שינוי אופציונלי. מתבצעת התקשרות כשכל הווידאו מוכן.
createPlayer()
יצירת אובייקט IMA Player
ריק. עליכם להטמיע את הפונקציה loadUrl
כדי להפעיל מודעות. שאר הפונקציות הן אופציונליות.
מחזיר את הערך ima.Player
:
loadUrl(streamInfo)
מתבצעת קריאה כשהנגן מתחיל להפעיל כתובת URL. צריך ליישם את השיטה הזו כדי לטעון את הסטרימינג.
פרמטר | סוג | תיאור |
---|---|---|
streamInfo |
ima.StreamInfo |
מכילה מידע שנדרש להפעלת התוכן. |
מחלקה ima.StreamFormat
שדות
מגדיר את הפורמט של הזרם.
תכונות
שם | סוג | תיאור |
---|---|---|
DASH |
|
|
HLS |
|
Class ima.StreamInfo
שדות
שיטות
מידע שמועבר מ-SDK לנגן לגבי השידור.
תכונות
שם | סוג | תיאור |
---|---|---|
format |
|
פורמט הסרטון: hls או מקף. מוגדר ב-ima.StreamFormat. |
manifest |
|
כתובת ה-URL של הסטרימינג. |
streamId |
|
מזהה ייחודי של מקור הנתונים. |
streamType |
|
סוג הסרטון: בשידור חי או על פי דרישה. מוגדר ב-ima.StreamType. |
subtitles |
|
כתוביות, אם יש כאלה. הערך לא חוקי אם לא. |
createStreamInfo()
מחזיר את ima.StreamInfo
:
Class ima.StreamManager
שיטות
אובייקט לניהול ההפעלה של השידור.
addEventListener(event, callback)
הוספת האזנה לאירוע שצוין. ראה קבוע AdEvents עבור
אירועים נתמכים.
פרמטר | סוג | תיאור |
---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
מחזיר את ima.StreamManager
:
פרמטר | סוג | תיאור |
---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
אין תמיכה. במקום זאת, יש להעביר נתונים מהמודעה הנלווית אל RAF ישירות.
זו אפשרות שלא ניתן להפעיל אותה כרגע.
getContentTime(streamTime)
הפונקציה מקבלת את משך הזמן באלפיות השנייה של שידור VOD, שמייצג את הזמן בתוכן ללא מודעות.
למידע נוסף: https://developers.google.com/ad-manager/Dynamic-ad-insertion/sdk/roku/faq
כדי לקבל את זמן התוכן לשידור הנוכחי של השידור החי – 1-.
מוחזר הערך Integer
: זמן התוכן שתואם לזמן השידור הנתון.
פרמטר | סוג | תיאור |
---|---|---|
streamTime |
Integer |
השעה בזרם. |
getCuePoints()
מחזירה את כל נקודות הסימון שמתאימות לכל ההפסקות למודעות. האפשרות הזו תקפה רק לתוכן וידאו על פי דרישה (VOD), שבו כל ההפסקות למודעות ידועות מראש. כל הזמנים מייצגים את זמן השידור בשניות.
מחזירה את Object
: מערך עם כל נקודות הסימן.
getPreviousCuePoint(time)
מחזירה את נקודת סימון שהתקיימה לפני הזמן הזה. נקודת הרמז מציינת הפסקה
למודעה. כל הזמנים מייצגים את זמן השידור בשניות.
מחזירה את הערך ima.CuePoint
: אובייקט עם start, end ו-hasPlayed. פונקציה זו מחזירה
את הערך הלא חוקי אם אין נקודת סימון זמינה.
פרמטר | סוג | תיאור |
---|---|---|
time |
Float |
הזמן לחיפוש, 1- מציין את השעה הנוכחית. |
getStreamTime(contentTime)
הפונקציה מקבלת את הזמן של השידור מזמן התוכן של VOD באלפיות השנייה.
למידע נוסף: https://developers.google.com/ad-manager/Dynamic-ad-insertion/sdk/roku/faq
החזרות Integer
: זמן השידור התואם לזמן התוכן הנתון.
פרמטר | סוג | תיאור |
---|---|---|
contentTime |
Integer |
מועד התוכן |
loadThirdPartyStream(streamManifest, streamSubtitle)
טוען את המטא-נתונים של המודעה ומפעיל את הפונקציה loadUrl
עם הנתונים שסופקו על ידי streamManifestUrl
ו-streamSubtitle
. הפונקציה הזו פועלת רק כשסוג הבקשה של מקור הנתונים הוא
ima.StreamType.POD_VOD
.
פרמטר | סוג | תיאור |
---|---|---|
streamManifest |
string |
כתובת ה-URL של המניפסט של השידור עם מודעות מחוברות. |
streamSubtitle |
ifArray |
הכתוביות משויכות לשידור, או |
onMessage(msg)
טיפול בכל ההודעות שמגיעות מאובייקט הווידאו.
יש לקרוא לפונקציה עבור כל הודעה שמתקבלת ב-roMessagePort.
פרמטר | סוג | תיאור |
---|---|---|
msg |
object |
ההודעה מיציאת roVideo. |
replaceAdTagParameters(adTagParameters)
הפונקציה מחליפה את כל הפרמטרים של תג המודעה שישמשו בבקשות עתידיות להצגת מודעות בשידור חי. חשוב לדעת שהשיחה הזו לא ניתנת להפעלה בשידורי VOD.
פרמטר | סוג | תיאור |
---|---|---|
adTagParameters |
string |
הפרמטרים החדשים של תגי מודעות. |
start()
מתחיל את ההפעלה של הזרם.
Class ima.StreamRequest
שדות
שיטות
משמש לציון המאפיינים של בקשת השידור.
תכונות
שם | סוג | תיאור |
---|---|---|
adTagParameters |
|
זה שינוי אופציונלי. תוכלו לשנות קבוצה מוגבלת של פרמטרים של תגי מודעות בבקשת השידור. האפשרות הוספת פרמטרים לטירגוט של השידור מספקת מידע נוסף. אפשר גם להשתמש בפרמטרים dai-ot ו-dai-ov כדי לציין את ההעדפה של הווריאציה של הסטרימינג. מידע נוסף זמין במאמר שינוי פרמטרים של וריאנטים של השידור. |
adUiNode |
|
צומת של תרשים סצנות שבו מוצג ממשק המשתמש של המודעה. IMA מציבה רכיבים כמו הלחצנים למה המודעה הזו ודילוג ברכיב הזה במהלך המודעות. הרכיב חייב להציג שכבת-על של כל רכיב הווידאו. |
apiKey |
|
זה שינוי אופציונלי. ניתן להשתמש במפתחות האלה כדי לאמת בקשות לשידור. יש להגדיר מפתחות אימות DAI בממשק המשתמש של DFP. |
assetKey |
|
חובה ביחס לשידורים חיים. משמש כדי לקבוע באיזה שידור צריך להפעיל. מפתח הנכס של בקשת השידור החי הוא מזהה שמופיע בממשק המשתמש של DFP. |
authToken |
|
אסימון ההרשאה של בקשת השידור. משתמשים בו במקום מפתח ה-API לצורך הרשאה מחמירה יותר של תוכן. בעל התוכן הדיגיטלי יכול לשלוט בהרשאות ספציפיות לשידורי תוכן על סמך האסימון הזה. |
contentSourceId |
|
חובה בשידורים על פי דרישה. ה-cmsid מגיע ממקור תוכן הווידאו של DFP בממשק המשתמש של DFP. |
customAssetKey |
|
מפתח הנכס המותאם אישית משמש כדי לקבוע איזה שידור להפעיל. מפתחות נכסים מותאמים אישית נדרשים לבקשות שידור של רצף להצגת מודעות. |
format |
|
הפורמט של הסטרימינג. ברירת המחדל היא |
networkCode |
|
קוד הרשת של בעל התוכן הדיגיטלי ששלח את בקשת השידור. קודי רשת נדרשים לבקשות שידור ל-pod. |
player |
|
יישום של ממשק הנגן. |
ppid |
|
הוּצא משימוש. צריך להשתמש בפרמטרים adTagParameter. זה שינוי אופציונלי. מזהה שסופק על ידי בעל האתר של DFP Audience. |
streamActivityMonitorId |
|
המזהה שישמש לניפוי באגים בשידור באמצעות כלי המעקב אחר הפעילות של השידור. זה משמש כדי לאפשר לבעלי אתרים למצוא יומן סטרימינג בכלי למעקב אחר פעילות סטרימינג. |
videoId |
|
חובה בשידורים על פי דרישה. מזהה של מקור תוכן הסרטון. |
videoObject |
|
אובייקט הסרטון (למשל Video roSGNode) אחראי להפעלת הסרטון באפליקציית הלקוח. תתבצע בדיקה של האובייקט כדי לבקש שימוש בנתונים שונים לתזמון נכון של אירועי HLS ID3 בשידור חי. |
createLiveStreamRequest(assetKey, apiKey)
מפעיל את המאפיינים הנדרשים של StreamRequest
בשידור חי. שימוש ב-API הזה גורם להתעלמות ממאפיינים אחרים שספציפיים ל-StreamType
.
אם הפרמטרים הנדרשים הם מחרוזות ריקות, מתרחש רישום שגיאות וה-API
מחזיר StreamRequest
גנרי בלי להתעלם ממאפיינים.
מחזיר אובייקט ima.StreamRequest
: אובייקט ima.StreamRequest
עם המאפיינים הפעילים הנדרשים.
פרמטר | סוג | תיאור |
---|---|---|
assetKey |
string |
|
apiKey |
string |
פרמטר אופציונלי שיוקצה למאפיין |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
מפעיל את המאפיינים הנדרשים של ima.StreamRequest
Pod Live.
שימוש ב-API הזה גורם להתעלמות ממאפיינים אחרים שספציפיים ל-ima.StreamType
.
אם הפרמטרים הנדרשים הם מחרוזות ריקות, מתרחש רישום שגיאות וה-API
מחזיר StreamRequest
גנרי בלי להתעלם ממאפיינים.
מחזיר אובייקט StreamRequest
: אובייקט ima.StreamRequest
עם מאפייני PodLive נדרשים.
פרמטר | סוג | תיאור |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
פרמטר אופציונלי שיוקצה למאפיין |
createPodVodStreamRequest(networkCode)
מפעיל את המאפיינים הנדרשים של ima.StreamRequest
כדי
לרשום שידור VOD כשמשתמשים בהצגת DAI Pod באמצעות צורף וידאו של
צד שלישי. הפונקציה מגדירה את סוג הבקשה
ל-ima.StreamType.POD_VOD
ומאמתת את כל המאפיינים הנדרשים
לנתונים חסרים. אימותים שנכשלו יתעדו שגיאה במסוף
ניפוי הבאגים.
מחזירה את הערך StreamRequest
: אובייקט ima.StreamRequest
. אם ציינתם את כל המאפיינים הנדרשים, סוג הבקשה מוגדר כ-ima.StreamType.POD_VOD
.
פרמטר | סוג | תיאור |
---|---|---|
networkCode |
string |
את הקוד של רשת Google Ad Manager |
createStreamRequest()
מחזירה את הערך ima.StreamRequest
: אובייקט ima.StreamRequest
ריק.
createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)
מפעיל את המאפיינים הנדרשים של Video Stitcher Live StreamRequest
. שימוש ב-API הזה גורם להתעלמות מנכסים אחרים שספציפיים ל-StreamType
.
אם הפרמטרים הנדרשים הם מחרוזות ריקות, מתרחש רישום שגיאות וה-API
מחזיר StreamRequest
גנרי בלי להתעלם ממאפיינים.
מחזיר את האובייקט ima.StreamRequest
: אובייקט ima.StreamRequest
עם המאפיינים הנדרשים של VideoStitcherLive.
פרמטר | סוג | תיאור |
---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
liveConfigId |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)
מפעיל את המאפיינים הנדרשים של Video Stitcher VOD
StreamRequest
. שימוש ב-API הזה גורם להתעלמות מנכסים אחרים שספציפיים ל-StreamType
.
אם הפרמטרים הנדרשים הם מחרוזות ריקות, מתרחש רישום שגיאות וה-API
מחזיר StreamRequest
גנרי בלי להתעלם ממאפיינים.
מחזיר את האובייקט ima.StreamRequest
: אובייקט ima.StreamRequest
עם מאפייני VideoStitcherVod הנדרשים.
פרמטר | סוג | תיאור |
---|---|---|
adTagUrl |
string |
|
networkCode |
string |
|
contentSourceUrl |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey)
מפעיל את המאפיינים הנדרשים של VOD ima.StreamRequest
. שימוש ב-API הזה גורם להתעלמות ממאפיינים אחרים שספציפיים ל-ima.StreamType
.
אם הפרמטרים הנדרשים הם מחרוזות ריקות, מתרחש רישום שגיאות וה-API
מחזיר StreamRequest
גנרי בלי להתעלם ממאפיינים.
מחזיר אובייקט ima.StreamRequest
: ima.StreamRequest
עם מאפייני VOD הנדרשים.
פרמטר | סוג | תיאור |
---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
פרמטר אופציונלי שיוקצה למאפיין |
Class ima.StreamType
שדות
מגדיר את סוג השידור שהנגן מתבקש להפעיל. מודעות לפני סרטון (pre-roll) ו-VOD צריכים לפעול מתחילת השידור.
תכונות
שם | סוג | תיאור |
---|---|---|
LIVE |
|
הסרטון עלה לאוויר. |
VOD |
|
הסרטון מוצע על פי דרישה. |
Class ima.WrapperInfo
שדות
שיטות
מכיל מידע על wrapper.
תכונות
שם | סוג | תיאור |
---|---|---|
adId |
|
מזהה המודעה או מחרוזת ריקה אם היא לא ידועה. |
adSystem |
|
השם המוצהר של מערכת המודעות או מחרוזת ריקה אם היא לא ידועה. |
creativeAdId |
|
מזהה המודעה בקריאייטיב או מחרוזת ריקה אם היא לא ידועה. |
creativeId |
|
המזהה של הקריאייטיב או מחרוזת ריקה אם היא לא ידועה. |
dealId |
|
מזהה העסקה או מחרוזת ריקה אם היא לא ידועה. |
createWrapperInfo()
מחזיר את ima.WrapperInfo
: