ממשקי 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

Class google.ima.dai.api.Ad

Methods

‪getAdId, getAdPodInfo, getAdSystem, getAdvertiserName, getApiFramework, getCompanionAds, getCreativeAdId, getCreativeId, getDealId, getDescription, getDuration, getTitle, getVastMediaHeight, getVastMediaWidth, getWrapperAdIds, getWrapperAdSystems, getWrapperCreativeIds

מחלקת ייצוג של אובייקט מודעה במהלך הצגת מודעות דינמיות. הכיתה הזו חושפת קבוצת משנה של מאפייני 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>:

Class google.ima.dai.api.AdPodInfo

Methods

‪getAdPosition, getMaxDuration, getPodIndex, getTimeOffset, getTotalAds

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

getAdPosition()

החזרות number:

getMaxDuration()

החזרות number:

getPodIndex()

החזרות number:

getTimeOffset()

החזרות number:

getTotalAds()

החזרות number:

Class google.ima.dai.api.AdProgressData

שדות

‪adBreakDuration, adPosition, currentTime, duration, totalAds

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

מאפיינים

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

Class google.ima.dai.api.CompanionAd

Methods

‪getAdSlotId, getContent, getContentType, getHeight, getWidth

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

getAdSlotId()

החזרות string:

getContent()

החזרות string:

getContentType()

החזרות string:

getHeight()

החזרות number:

getWidth()

החזרות number:

Class google.ima.dai.api.CuePoint

שדות

‫end, played, start

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

מאפיינים

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

Class google.ima.dai.api.LiveStreamRequest

שדות

assetKey

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

‫Constructor:

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

מאפיינים

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

Class google.ima.dai.api.StreamData

שדות

‪adProgressData, cuepoints, errorMessage, streamId, subtitles, url

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

מאפיינים

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

Class google.ima.dai.api.StreamEvent

Methods

getAd, getStreamData

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

getAd()

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

getStreamData()

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

Enum google.ima.dai.api.StreamEvent.Type

שדות

AD_BREAK_ENDED, AD_BREAK_STARTED, AD_PROGRESS, CLICK, COMPLETE, CUEPOINTS_CHANGED, ERROR, FIRST_QUARTILE, LOADED, MIDPOINT, STARTED, STREAM_INITIALIZED, THIRD_QUARTILE

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

ערכים

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

Class google.ima.dai.api.StreamManager

Methods

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

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

‫Constructor:

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

contentTimeForStreamTime(streamTime)

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

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

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

onTimedMetadata(metadata)

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

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

previousCuePointForStreamTime(streamTime)

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

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

פרמטר	סוג	תיאור
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)

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

Returns number: the stream time that corresponds with the given content time once ads are inserted.

פרמטר	סוג	תיאור
contentTime	number	משך התוכן ללא פרסומות (בשניות).

Class google.ima.dai.api.StreamRequest

שדות

adTagParameters, apiKey, streamActivityMonitorId

מחלקת הגדרת מאפיינים של בקשת הסטרימינג.

מאפיינים

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

Class google.ima.dai.api.VODStreamRequest

שדות

contentSourceId, videoId

מחלקת הגדרת מאפיינים של בקשת סטרימינג של VOD.

‫Constructor:

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

מאפיינים

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

הקבוע google.ima.VERSION

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