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

    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

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

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

getAdPosition()


החזרות number:

getMaxDuration()


החזרות number:

getPodIndex()


החזרות number:

getTimeOffset()


החזרות number:

getTotalAds()


החזרות number:

Class google.ima.dai.api.AdProgressData

שדות

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

מאפיינים

שם סוג תיאור
adBreakDuration

adPosition

currentTime

duration

totalAds

Class google.ima.dai.api.CompanionAd

Methods

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

getAdSlotId()


החזרות string:

getContent()


החזרות string:

getContentType()


החזרות string:

getHeight()


החזרות number:

getWidth()


החזרות number:

Class google.ima.dai.api.CuePoint

שדות

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

מאפיינים

שם סוג תיאור
end

זמן הסיום של נקודת ה-cue הזו.
played

אם נקודת האות הזו הופעלה.
start

שעת ההתחלה של נקודת ה-cue הזו.

Class google.ima.dai.api.LiveStreamRequest

שדות

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

Constructor:
פרמטר סוג תיאור
opt_liveStreamRequest Object

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

מאפיינים

שם סוג תיאור
assetKey

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

Class google.ima.dai.api.StreamData

שדות

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

מאפיינים

שם סוג תיאור
adProgressData

מידע שקשור לתזמון של המודעה שמופעלת כרגע.
cuepoints

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

streamId

subtitles

url

Class google.ima.dai.api.StreamEvent

Methods

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

getAd()

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

getStreamData()

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

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

שדות

רשימה של סוגי האירועים שנתמכים על ידי 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

Methods

מטפל בשידורים עם הטמעת מודעות דינמיות. הוא מנהל אינטראקציות עם ה-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: נקודת האות הקודמת לזמן השידור שצוין.

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

זמן התוכן בלי פרסומות (בשניות).

Class google.ima.dai.api.StreamRequest

שדות

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

מאפיינים

שם סוג תיאור
adTagParameters

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

מפתח ה-API של בקשת השידור. ההגדרה מתבצעת דרך ממשק המשתמש של DFP Admin והיא מסופקת לבעל האתר כדי לפתוח את התוכן שלו. הוא מאמת את האפליקציות שמנסות לגשת לתוכן.
streamActivityMonitorId

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

‫Class google.ima.dai.api.VODStreamRequest

שדות

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

Constructor:
פרמטר סוג תיאור
opt_VODStreamRequest Object

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

מאפיינים

שם סוג תיאור
contentSourceId

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

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

הקבוע google.ima.VERSION

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