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

שיטות

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

שיטות

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

שיטות

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		שעת הסיום של נקודת הסימון הזו.
played		אם נקודת הסימון הזו הופעלה.
start		שעת ההתחלה של נקודת הסימון הזו.

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 של האירוע AdEvent‏ CUEPOINTS_CHANGED.
errorMessage
streamId
subtitles
url

Class google.ima.dai.api.StreamEvent

שיטות

getAd,‏getStreamData

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

getAd()

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

getStreamData()

החזרת 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	נשלחים לשידורים על פי דרישה כשנקודות העצירה משתנות.
ERROR	האירוע מופעל כשמתרחשת שגיאה.
FIRST_QUARTILE	האירוע מופעל כשמודעה מגיעה לרבעון הראשון שלה.
LOADED	האירוע מופעל כשמניפסט הסטרימינג זמין.
MIDPOINT	האירוע מופעל כשמודעה מגיעה לנקודת האמצע שלה.
STARTED	האירוע מופעל כשמודעה מתחילה.
STREAM_INITIALIZED	האירוע מופעל כשהסטרימינג מופעל.
THIRD_QUARTILE	האירוע מופעל כשמודעה מגיעה לרבעון השלישי שלה.

Class google.ima.dai.api.StreamManager

שיטות

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

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

מבנה (constructor):

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

contentTimeForStreamTime(streamTime)

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

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

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

onTimedMetadata(metadata)

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

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

previousCuePointForStreamTime(streamTime)

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

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

פרמטר	סוג	תיאור
streamTime	number	שעת הסטרימינג שאליו בוצע המעבר.

processMetadata(type, data, timestamp)

עיבוד מטא-נתונים מתוזמנים לשידורים חיים. משתמשים ב-method הזה אם נגן הווידאו מספק מטא-נתונים לא מנותחים יחד עם חותמות זמן. אחרת, צריך להפעיל את ה-method 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	משך התוכן ללא מודעות (בשניות).

Class google.ima.dai.api.StreamRequest

שדות

adTagParameters,‏apiKey,‏streamActivityMonitorId

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

מאפיינים

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

Class google.ima.dai.api.VODStreamRequest

שדות

contentSourceId,‏videoId

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

מבנה (constructor):

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

מאפיינים

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

הקבוע google.ima.VERSION

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