ממשקי API של Google IMA DAI SDK

1. 1. google.ima.dai.api.Ad
   2. google.ima.dai.api.AdPodInfo
   3. google.ima.dai.api.AdProgressData
   4. google.ima.dai.api.CompanionAd
   5. google.ima.dai.api.CuePoint
   6. google.ima.dai.api.LiveStreamRequest
   7. google.ima.dai.api.StreamData
   8. google.ima.dai.api.StreamEvent
   9. google.ima.dai.api.StreamEvent.Type
   10. google.ima.dai.api.StreamManager
   11. google.ima.dai.api.StreamRequest
   12. google.ima.dai.api.VODStreamRequest
   13. google.ima.VERSION

רמה google.ima.dai.api.Ad

שיטות

getAdId, getAdPodInfo, {getAdSystem, getAdvertiserName, getApiFramework, getCompanionAds, getCreativeAdId, getCreativeId, getCreativeId, getDealIdgetDescriptiongetDurationgetTitlegetVastMediaHeightgetVastMediaWidthgetWrapperAdIdsgetWrapperAdSystemsgetWrapperCreativeIds

מחלקה המייצגת אובייקט של מודעה במהלך הכנסת מודעה דינמית. המחלקה הזו חושפת קבוצת משנה של מאפייני ima.Ad.

getAdId()

מחזיר string:

getAdPodInfo()

מחזיר google.ima.dai.api.AdPodInfo:

getAdSystem()

מחזיר string:

getAdvertiserName()

מחזיר string:

getApiFramework()

מחזיר string:

getCompanionAds()

מחזיר Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()

מחזיר string:

getCreativeId()

מחזיר string:

getDealId()

מחזיר string:

getDescription()

מחזיר string:

getDuration()

מחזיר number:

getTitle()

מחזיר string:

getVastMediaHeight()

מחזיר number:

getVastMediaWidth()

מחזיר number:

getWrapperAdIds()

מחזיר Array.<string>:

getWrapperAdSystems()

מחזיר Array.<string>:

getWrapperCreativeIds()

מחזיר Array.<string>:

רמה google.ima.dai.api.AdPodInfo

שיטות

getAdPosition, getMaxDuration, getPodIndex, getTimeOffset, getTotalAds

מחלקה שמייצגת אובייקט מידע של רצף מודעות במהלך הוספה של מודעה דינמית. מחלקה זו חושפת קבוצת משנה של מאפייני ima.AdPodInfo.

getAdPosition()

מחזיר number:

getMaxDuration()

מחזיר number:

getPodIndex()

מחזיר number:

getTimeOffset()

מחזיר number:

getTotalAds()

מחזיר number:

רמה google.ima.dai.api.AdProgressData

שדות

adBreakDuration, adPosition, currentTime, duration, totalAds

מחלקה לציון נתוני ההתקדמות של המודעה.

תכונות

שם	תיאור	התיאור
adBreakDuration
adPosition
currentTime
duration
totalAds

רמה google.ima.dai.api.CompanionAd

שיטות

getAdSlotId, getContent, getContentType, getHeight, getWidth

מחלקה שמייצגת אובייקט של מודעה נלווית במהלך הוספה של מודעה דינמית. מחלקה זו חושפת קבוצת משנה של המאפיינים ima.CompanionAd.

getAdSlotId()

מחזיר string:

getContent()

מחזיר string:

getContentType()

מחזיר string:

getHeight()

מחזיר number:

getWidth()

מחזיר number:

רמה google.ima.dai.api.CuePoint

שדות

end, played, start

מחלקה לציון מאפיינים של נקודת סימון שמייצגת הפסקה למודעה בשידורי DAI VOD.

תכונות

שם	תיאור	התיאור
end		שעת הסיום של נקודת הציון הזו.
played		אם נקודת העצירה הזו הופעלה.
start		שעת ההתחלה של נקודת הציון הזו.

רמה google.ima.dai.api.LiveStreamRequest

שדות

assetKey

מחלקה לציון המאפיינים של הבקשה לשידור חי.

בונה:

פרמטר	תיאור	התיאור
opt_liveStreamRequest	Object	באובייקט שכבר הוקצו לו מאפיינים של בקשת זרם.

תכונות

שם	תיאור	התיאור
assetKey		הגדרה זו משמשת כדי לקבוע איזה שידור צריך להפעיל. מפתח הנכס של בקשה לשידור חי הוא מזהה שנמצא בממשק המשתמש של DFP.

רמה google.ima.dai.api.StreamData

שדות

adProgressData, cuepoints, errorMessage, streamId, subtitles, url

מחלקה לציון נתוני מקור הנתונים.

תכונות

שם	תיאור	התיאור
adProgressData		מידע הקשור לתזמון של המודעה שפועלת כרגע.
cuepoints		נקודות הציון של המודעות בשידור על פי דרישה. הם עשויים להשתנות עם התקדמות השידור. הערך הזה יאוכלס רק ב-event listener עבור CUEPOINTS_POINTS AdEvent.
errorMessage
streamId
subtitles
url

רמה google.ima.dai.api.StreamEvent

שיטות

getAd, getStreamData

מנהל השידור מציג את סוג האירוע הזה כהתראה כאשר מצב השידור משתנה.

getAd()

מחזירה google.ima.dai.api.Ad: אובייקט שמחזיר את פרטי המודעה.

getStreamData()

מחזירה google.ima.dai.api.StreamData: אובייקט חוזר עם מידע על מקור הנתונים.

דוגמאות google.ima.dai.api.StreamEvent.Type

שדות

AD_BREAK_ENDED, AD_BREAK_STARTED, AD_PROGRESS, לחיצה, COMPLETE, CUEPOINTS_CHANGED, שגיאה, FIRST_QUARTILE, LOADEDMIDPOINTSTREAM_INITIALIZEDTHIRD_QUARTILE

רשימה של סוגי אירועים הנתמכים על ידי IMA SDK.

ערכים

Value	התיאור
AD_BREAK_ENDED	מופעל כשההפסקה למודעה מסתיימת.
AD_BREAK_STARTED	מופעל כשמתחילה הפסקה למודעה.
AD_PROGRESS	מופעל כשיש עדכון להתקדמות של מודעה.
CLICK	הן נשלחות כשלוחצים על אלמנט click או כשמקישים עליו בזמן שמופעלת מודעה.
COMPLETE	מופעל כשהצגת המודעה הושלמה.
CUEPOINTS_CHANGED	נשלחות לסטרימינג על פי דרישה כשנקודות היעד משתנות.
ERROR	מופעל כשמתרחשת שגיאה.
FIRST_QUARTILE	מופעל כשמודעה מגיעה לרבעון הראשון שלה.
LOADED	מופעל כשהמניפסט של השידור זמין.
MIDPOINT	מופעל כשמודעה מגיעה לנקודת האמצע שלה.
STARTED	מופעל כשמודעה מתחילה.
STREAM_INITIALIZED	מופעל כשהשידור מופעל.
THIRD_QUARTILE	מופעל כשמודעה מגיעה לרבעון השלישי.

רמה google.ima.dai.api.StreamManager

שיטות

contentTimeForStreamTime, onTimedMetadata previousCuePointForStreamTime, processMetadata, requestStream, setClickElement, streamTimeForContentTime

מטפל בשידורים של הכנסת מודעות דינמיות. הוא מנהל את האינטראקציות עם הקצה העורפי של DAI ומטפל בפינגים של מעקב, וגם בהעברות בסטרימינג ובאירועי מודעות אל בעל התוכן הדיגיטלי. חשבון הניהול הזה לא יורש מ-BaseAdsManager כי הוא לא מנהל של מודעה ספציפית, אלא מנהל של כל הזרם

בונה:

פרמטר	תיאור	התיאור
videoElement	HTMLVideoElement	הרכיב של נגן הווידאו עצמו.

contentTimeForStreamTime(streamTime)

מחזירה את זמן התוכן ללא מודעות עבור זמן שידור נתון. הפונקציה מחזירה את זמן השידור הנתון של שידורים חיים.

מחזירה number: זמן התוכן שתואם לשעת השידור הנתונה לאחר הסרת המודעות.

פרמטר	תיאור	התיאור
streamTime	number	זמן הסטרימינג עם מודעות שנוספו (בשניות).

onTimedMetadata(metadata)

כרטיסים במילון של מטא-נתונים מעובדים. המילון מצפה למפתח 'TXXX' עם מחרוזת המטא-נתונים שהוגדרה על ידי המשתמש. אם הנגן מספק מטא-נתונים גולמיים, יש להפעיל את ima.dai.api.StreamManager.processMetadata במקום זאת.

פרמטר	תיאור	התיאור
metadata	Object	המילון של המטא-נתונים.

previousCuePointForStreamTime(streamTime)

מחזירה את נקודת הרמז הקודמת לזמן השידור הנתון. הפונקציה מחזירה את הערך null אם לא קיימת נקודת סימון כזו. היא משמשת להטמעת תכונות כמו 'Snapback', והיא נקראת כאשר בעל התוכן הדיגיטלי מזהה שהמשתמש רצה להחזיר אותו להפסקה למודעה.

מחזירה google.ima.dai.api.CuePoint: נקודת הרמז הקודמת לזמן השידור הנתון.

פרמטר	תיאור	התיאור
streamTime	number	שעת השידור שחיפשתם.

processMetadata(type, data, timestamp)

עיבוד מטא-נתונים מתוזמנים לגבי שידורים חיים. צריך להשתמש באפשרות הזו אם נגן הווידאו מספק מטא-נתונים שלא נותחו יחד עם חותמות זמן. אחרת, צריך לבצע קריאה אל ima.dai.api.StreamManager.onTimedMetadata.

פרמטר	תיאור	התיאור
type	string	מקלידים מטא-נתונים. חייב להיות ID3.
data	Uint8Array	נתוני תג גולמיים. ל-ID3, חייב להיות התג כולו.
timestamp	number	הזמן שבו צריך לעבד את הנתונים.

requestStream(streamRequest)

המערכת מבקשת לטעון שידור באמצעות הפרמטרים של השידור שסופקו.

פרמטר	תיאור	התיאור
streamRequest	google.ima.dai.api.StreamRequest	מכיל פרמטרים לטעינת המטא-נתונים של השידור.

setClickElement(clickElement)

מגדיר את רכיב הקליק על המודעה. הרכיב הזה משמש כגורם שתומך בקליק או בהקשה בזמן שהמודעה פועלת, ויכול לגרום לניווט אל מחוץ לדף הנוכחי.

פרמטר	תיאור	התיאור
clickElement	Element	הרכיב המשמש למעבר של הקליק על המודעה.

streamTimeForContentTime(contentTime)

מחזירה את זמן השידור עם מודעות עבור זמן תוכן נתון. הפונקציה מחזירה את משך הזמן הנתון של שידורים חיים.

מחזירה number: זמן השידור התואם לזמן התוכן הנתון לאחר הוספת המודעות.

פרמטר	תיאור	התיאור
contentTime	number	זמן התוכן ללא מודעות (בשניות).

רמה google.ima.dai.api.StreamRequest

שדות

adTagParameters, apiKey, streamActivityMonitorId

מחלקה לציון מאפיינים של בקשת מקור הנתונים.

תכונות

שם	תיאור	התיאור
adTagParameters		ניתן לשנות קבוצה מוגבלת של פרמטרים של תגי מודעות בבקשת השידור. ספק פרמטרים של מיקוד לשידור שלך מספק מידע נוסף. אפשר להשתמש בפרמטרים 'dai-ot' ו-'dai-ov' להעדפה של הווריאנט של השידור. למידע נוסף, אפשר לקרוא את המאמר שינוי פרמטרים של וריאנטים של מקור נתונים.
apiKey		מפתח ה-API של בקשת השידור. המדיניות מוגדרת באמצעות ממשק המשתמש של DFP Admin ומסופקת לבעל התוכן הדיגיטלי כדי לבטל את נעילת התוכן שלו. היא מאמתת את האפליקציות שמנסות לגשת לתוכן.
streamActivityMonitorId		המזהה שישמש לניפוי באגים בזרם באמצעות המעקב אחר הפעילות בזרם. המידע הזה מספק דרך נוחה לאפשר לבעלי תוכן דיגיטלי למצוא יומן סטרימינג בכלי למעקב אחר פעילות סטרימינג.

רמה google.ima.dai.api.VODStreamRequest

שדות

contentSourceId, videoId

מחלקה לציון המאפיינים של הבקשה לשידור VOD.

בונה:

פרמטר	תיאור	התיאור
opt_VODStreamRequest	Object	אובייקט שכבר הוקצו לו מאפייני בקשת זרם.

תכונות

שם	תיאור	התיאור
contentSourceId		מזהה ייחודי של התוכן של בעל האתר, ממערכת ניהול תוכן. נדרש בשידורים לפי דרישה.
videoId		מזהה למקור תוכן הווידאו. חובה בשידורים לפי דרישה.

קבוע google.ima.VERSION

מחרוזת שמכילה את הגרסה המלאה של ה-SDK.