IMA DAI SDK ל-Roku

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

מחלקה ima

שיטות

disableLogging,‏getStreamManager,‏initSdk,‏requestStream

פונקציות גלובליות ששולטות ב-IMA SDK.

disableLogging()

השבתת הרישום ביומן של ה-SDK. רישום ביומן יופעל כברירת מחדל.

getStreamManager()

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

החזרת הערך object: מנהל הסטרימינג או אובייקט השגיאה.

initSdk(settings)

אתחול ה-SDK.

פרמטר	סוג	תיאור
settings	object	אובייקט אופציונלי של הגדרות IMA.

requestStream(streamRequest)

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

החזרת הערך object: שגיאה או 'לא חוקי' אם אין שגיאה

פרמטר	סוג	תיאור
streamRequest	object

חזרה למעלה

Class ima.AdBreakInfo

שדות

adPosition,‏ duration,‏ podIndex,‏ timeOffset,‏ totalAds

שיטות

createAdBreakInfo

מכיל מידע על הפסקה למודעה. ה-SDK מעביר את הפרמטר הזה לקריאות חוזרות של אירועים.

מאפיינים

שם	סוג	תיאור
adPosition		האינדקס של המודעה בהפסקה למודעה. הערך של המדד הוא 1 למודעות עצמאיות.
duration		משך ההפסקה המקסימלי בשניות, או -1 אם הוא לא ידוע.
podIndex		בשידורים חיים, הפונקציה מחזירה את מזהה ההפסקה כאינדקס של רצף המודעות, או את הערך 0 בשביל מודעה מוקדמת. אין מודעות פוסט-רול בשידורים חיים. ברירת המחדל היא -2. בסרטונים על פי דרישה (VOD), הפונקציה מחזירה את האינדקס של רצף המודעות. במודעת Preroll, הפונקציה מחזירה את הערך 0. במודעות Midroll, הפונקציה מחזירה את הערכים 1, ‏ 2,‏ …,‏ n. במודעת פוסט-רול, הפונקציה מחזירה את הערכים n+1…n+x. ערך ברירת המחדל הוא 0 אם המודעה הזו לא חלק מרצף מודעות, או אם רצף המודעות הזה לא חלק מפלייליסט.
timeOffset		המיקום של ה-Pod בתוכן בשניות. מודעות וידאו In-stream לפני הסרטון (pre-roll) מחזירות את הערך 0, מודעות וידאו In-stream בסוף הסרטון (post-roll) מחזירות את הערך -1 ומודעות וידאו In-stream באמצע הסרטון (mid-roll) מחזירות את המועד שנקבע לפוד.
totalAds		המספר הכולל של המודעות שמופיעות בהפסקה הזו למודעות. הערך הוא 1 במודעות עצמאיות.

createAdBreakInfo()

הפונקציה מחזירה את הערך ima.AdBreakInfo:

חזרה למעלה

הכיתה ima.AdEvent

שדות

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, START, THIRD_QUARTILE

אירועים שמופעל על ידי מנהל המודעות.

מאפיינים

שם	סוג	תיאור
AD_PERIOD_ENDED		האירוע הזה מופעל בכל פעם שהשידור עובר ממודעה או מקטע קידום מכירות לתוכן. האירוע הזה יופעל גם כשמודעה תוצג בפעם השנייה או כשמתבצעת דילוג אל מודעה.
AD_PERIOD_STARTED		האירוע הזה מופעל בכל פעם שהשידור עובר מתוכן לפרסום או לקופית חוסמת. האירוע הזה יופעל גם כשמודעה תוצג בפעם השנייה או כשמתבצעת דילוג אל מודעה.
COMPLETE		האירוע מופעל בסיום ההפעלה של המודעה.
ERROR		האירוע מופעל כשמתרחשת שגיאה.
FIRST_QUARTILE		האירוע הזה מופעל כשפס ההפעלה של המודעה חוצה את הרבעון הראשון.
ICON_FALLBACK_IMAGE_CLOSED		האירוע הזה מופעל כשהמשתמש סוגר את תיבת הדו-שיח של התמונה החלופית לסמל.
ICON_FALLBACK_IMAGE_SHOWN		האירוע מופעל כשהתמונה החלופית של הסמל מוצגת.
MIDPOINT		האירוע מופעל כשסמן ההתקדמות במודעה חוצה את נקודת האמצע.
PROGRESS		האירוע מופעל כשיש עדכון לגבי ההתקדמות של מודעה.
SKIPPABLE_STATE_CHANGED		האירוע מופעל כשהסטטוס של האפשרות לדלג על מודעה משתנה.
SKIPPED		האירוע מופעל כשמשתמש מדלג על מודעה.
START		האירוע מופעל כשמודעה מתחילה לפעול.
THIRD_QUARTILE		האירוע מופעל כשסמן ההתקדמות של המודעה חוצה את הרבעון השלישי.

חזרה למעלה

Class ima.AdInfo

שדות

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

שיטות

createAdInfo

מכיל מידע על מודעה. ה-SDK מעביר את הפרמטר הזה לקריאות חוזרות של אירועים.

מאפיינים

שם	סוג	תיאור
adBreakInfo		מידע לגבי ההפסקה כולה שבה מופיעה המודעה.
adDescription		תיאור המודעה.
adId		המזהה של המודעה או מחרוזת ריקה אם המזהה לא ידוע.
adSystem		מערכת המודעות שמספקת את הקריאייטיב.
adTitle		השם של המודעה.
advertiserName		שם המפרסם כפי שהוגדר על ידי הצד שמוצגות דרכו המודעות.
companions		מודעות הווידאו הנלווה שצוינו בתגובה ל-VAST.
creativeAdId		קוד ISCI (מזהה מסחרי לפי תקן התעשייה) של מודעה. זהו מזהה המודעה של הקריאייטיב שנבחר בתגובה ל-VAST.
creativeId		המזהה של נכס הקריאייטיב שנבחר עבור המודעה.
currentTime		השעה הנוכחית במודעה בשניות, או -1 אם השעה לא ידועה.
dealId		הפונקציה מחזירה את מזהה העסקה הראשון שמופיע בשרשרת העטיפה של המודעה הנוכחית, החל מהחלק העליון.
duration		משך המודעה היחידה הזו בשניות, או -1 אם לא ידוע.
skipOffset		הזמן שלוקח למודעה להיות ניתנת לדילוג, או ‎-1 אם לא ידוע.
universalAdIDRegistry		מחרוזת שמשמשת לזיהוי כתובת ה-URL של אתר המרשם שבו מופיע בקטגוריה מזהה המודעה האוניברסלי של הקריאייטיב שנבחר.
universalAdIDValue		מזהה המודעה האוניברסלי של נכס הקריאייטיב שנבחר עבור המודעה.
wrappers		מערך של ima.WrapperInfo עם פרטי העטיפה של המודעה הזו. הסדר יהיה מהאריזה החיצונית לתוך האריזה הפנימית.

createAdInfo()

הפונקציה מחזירה את הערך ima.AdInfo:

חזרה למעלה

Class ima.Companion

שדות

apiFramework,‏ creativeType,‏ height,‏ trackingEvents,‏ url,‏ width

שיטות

createCompanion

מכיל מידע על מודעות נלוויות.

מאפיינים

שם	סוג	תיאור
apiFramework		ממשק ה-API הנדרש להפעלת המודעה הזו, או 'לא תקין' אם הוא לא זמין.
creativeType		מייצג את סוג הקריאייטיב, בדרך כלל mimetype.
height		הגובה של המודעה הנלווית בפיקסלים. 0 אם לא זמין.
trackingEvents		מפה של אירועי מעקב שבה המפתח הוא האירוע והערך הוא רשימת כתובות URL ששולחות הודעות ping כשמתרחש האירוע הזה.
url		כתובת ה-URL של המשאב הסטטי של המלווה הזה.
width		רוחב המודעה הנלווית בפיקסלים. 0 אם לא זמין.

createCompanion()

הפונקציה מחזירה את הערך ima.Companion:

חזרה למעלה

Class ima.CuePoint

שדות

end,‏hasPlayed,‏start

שיטות

createCuePoint

מכיל מידע על נקודת סימון.

מאפיינים

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

createCuePoint()

הפונקציה מחזירה את הערך ima.CuePoint:

חזרה למעלה

הכיתה ima.Error

שדות

id,‏info,‏type

שיטות

createError

אובייקט שמוענק לטיפול בשגיאות אם יש שגיאה.

מאפיינים

שם	סוג	תיאור
id		המזהה של השגיאה. ברשימה של קודי השגיאה שמופיעה בערך הקבוע ErrorEvent מפורטות כל השגיאות האפשריות.
info		מידע נוסף על השגיאה.
type		תמיד מגדירים את הערך הזה כ-error כדי לציין את סוג האובייקט.

createError()

הפונקציה מחזירה את הערך ima.Error:

חזרה למעלה

Class ima.ErrorEvent

שדות

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

כל השגיאות ש-SDK עשוי לשלוח בחזרה.

מאפיינים

שם	סוג	תיאור
BAD_STREAM_REQUEST		הבקשה להעברת הנתונים לא אוכלסה כראוי.
COULD_NOT_LOAD_STREAM		לא ניתן היה לטעון את השידור.
ERROR		שגיאה לא ידועה.
INVALID_RESPONSE		תגובת השרת לא תקינה.
STREAM_API_KEY_NOT_VALID		מפתח ה-API שסופק לא אושר על ידי השרת.

חזרה למעלה

הכיתה ima.Player

שיטות

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

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

פרמטר	סוג	תיאור
adBreakInfo	ima.AdBreakInfo	מכיל מידע על ההפסקה למודעה.

adBreakStarted(adBreakInfo)

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

פרמטר	סוג	תיאור
adBreakInfo	ima.AdBreakInfo	מכיל מידע על ההפסקה למודעה.

allVideoComplete()

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

createPlayer()

יצירת אובייקט Player ריק של IMA. כדי להפעיל מודעות, צריך להטמיע את הפונקציה loadUrl. פונקציות אחרות הן אופציונליות.

הפונקציה מחזירה את הערך ima.Player:

loadUrl(streamInfo)

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

פרמטר	סוג	תיאור
streamInfo	ima.StreamInfo	מכיל מידע שנחוץ להפעלת התוכן.

חזרה למעלה

סיווג ima.StreamFormat

שדות

DASH,‏HLS

מגדיר את הפורמט של הסטרימינג.

מאפיינים

שם	סוג	תיאור
DASH
HLS

חזרה למעלה

סיווג ima.StreamInfo

שדות

format,‏ manifest,‏ streamId,‏ streamType,‏ subtitles

שיטות

createStreamInfo

מידע על הסטרימינג שמועברים מה-SDK לנגן.

מאפיינים

שם	סוג	תיאור
format		הפורמט של הסרטון: hls או dash. מוגדר ב-ima.StreamFormat.
manifest		כתובת ה-URL של השידור.
streamId		מזהה ייחודי של הסטרימינג.
streamType		סוג הסרטון: בשידור חי או על פי דרישה. מוגדר ב-ima.StreamType.
subtitles		כתוביות, אם יש כאלה. אם לא, הערך לא חוקי.

createStreamInfo()

הפונקציה מחזירה את הערך ima.StreamInfo:

חזרה למעלה

הכיתה ima.StreamManager

שיטות

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

אובייקט לניהול ההפעלה של שידור.

addEventListener(event, callback)

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

פרמטר	סוג	תיאור
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

הפונקציה מחזירה את הערך ima.StreamManager:

פרמטר	סוג	תיאור
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

לא נתמך. במקום זאת, מעבירים נתונים מהמודעה הנלווית ישירות ל-RAF. זה לא נדרש יותר.

getContentTime(streamTime)

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

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

פרמטר	סוג	תיאור
streamTime	Integer	השעה בשידור.

getCuePoints()

הפונקציה מחזירה את כל נקודות האות שתואמות לכל ההפסקות למודעות. האפשרות הזו רלוונטית רק לתוכן של וידאו על פי דרישה, שבו כל ההפסקות למודעות ידועות מראש. כל הזמנים מייצגים את זמן הסטרימינג בשניות. במקורות של Cloud Stitching API, המאפיין hasPlayed של כל ima.CuePoint הוא תמיד false.

החזרת Object: מערך עם כל נקודות העצירה.

getPreviousCuePoint(time)

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

החזרת ima.CuePoint: אובייקט עם start,‏ end ו-hasPlayed. הפונקציה מחזירה את הערך Invalid אם אין נקודת סימון זמינה.

פרמטר	סוג	תיאור
time	Float	השעה לחיפוש, -1, מציינת את השעה הנוכחית ומחזירה את הערך Invalid לכל שאר המקורות.

getStreamTime(contentTime)

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

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

פרמטר	סוג	תיאור
contentTime	Integer	מועד פרסום התוכן.

loadThirdPartyStream(streamManifest, streamSubtitle)

הקוד הזה טוען את המטא-נתונים של המודעה וקורא לפונקציה loadUrl עם הנתונים של streamManifestUrl ו-streamSubtitle. הפונקציה הזו פועלת רק כשסוג הבקשה להעברת הנתונים הוא ima.StreamType.POD_VOD.

פרמטר	סוג	תיאור
streamManifest	string	כתובת ה-URL של המניפסט של הסטרימינג עם המודעות שתוזנו.
streamSubtitle	ifArray>|Invalid	הכתוביות שמשויכות לשידור, או Invalid אם אין כאלה.

onMessage(msg)

מטפל בכל ההודעות שמגיעות מאובייקט הווידאו. צריך לקרוא ל-method הזה לכל הודעה שמתקבלת ב-roMessagePort.

פרמטר	סוג	תיאור
msg	object	ההודעה מהיציאה roVideo.

replaceAdTagParameters(adTagParameters)

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

פרמטר	סוג	תיאור
adTagParameters	string	הפרמטרים החדשים של תג המודעות.

start()

הפעלת הסטרימינג.

חזרה למעלה

הכיתה ima.StreamRequest

שדות

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

שיטות

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

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

מאפיינים

שם	סוג	תיאור
adTagParameters		זה שינוי אופציונלי. אתם יכולים לשנות את ההגדרות של קבוצה מוגבלת של פרמטרים של תגי מודעות בבקשת הסטרימינג. מידע נוסף זמין במאמר הוספת פרמטרים של טירגוט לשידור. אפשר גם להשתמש בפרמטרים dai-ot ו-dai-ov כדי להגדיר העדפה לגרסה של שידור. מידע נוסף זמין במאמר שינוי פרמטרים של וריאנטים של שידורים.
adUiNode		צומת בתרשים סצינה שבו מוצג ממשק המשתמש של המודעה. IMA ממוקם רכיבים כמו Why This Ad (למה המודעה הזו) ולחצני Skip (דילוג) ברכיב הזה במהלך המודעות. הרכיב חייב להופיע בשכבת-על מעל רכיב הסרטון כולו.
apiKey		זה שינוי אופציונלי. אפשר להשתמש במפתחות האלה כדי לאמת בקשות סטרימינג. צריך להגדיר את מפתחות האימות של DAI בממשק המשתמש של DFP.
assetKey		נדרש בשידורים חיים. הוא משמש לקביעת מקור הסטרימינג שיופעל. מפתח הנכס של בקשת השידור החי הוא מזהה שאפשר למצוא בממשק המשתמש של DFP.
authToken		טוקן ההרשאה של בקשת הסטרימינג. משמש במקום מפתח ה-API לצורך הרשאת תוכן מחמירה יותר. על סמך האסימון הזה, בעל התוכן הדיגיטלי יכול לשלוט בהרשאות של מקורות תוכן ספציפיים.
contentSourceId		חובה בשידורים על פי דרישה. השדה cmsid מגיע ממקור תוכן הווידאו ב-DFP בממשק המשתמש של DFP.
customAssetKey		מפתח הנכס המותאם אישית משמש לקביעת השידור שצריך להפעיל. מפתחות נכסים מותאמים אישית נדרשים לבקשות של שידור פוד.
format		הפורמט של הסטרימינג. ברירת המחדל היא ima.StreamFormat.HLS.
networkCode		קוד הרשת של בעל התוכן הדיגיטלי ששולח את בקשת הסטרימינג. קודי רשת נדרשים לבקשות להצגת סטרימינג של מודעות ב-Pod שנשלחות באמצעות createPodLiveStreamRequest או createPodVodStreamRequest. הקודים האלה נדרשים גם לבקשות סטרימינג של Cloud Stitching שנשלחות באמצעות createVideoStitcherLiveStreamRequest,‏ createVideoStitcherVodStreamRequest או createVideoStitcherVodStreamRequestWithVodConfig. הקודים האלה הם אופציונליים ומומלצים לבקשות סטרימינג של שירות מלא שנשלחות באמצעות createLiveStreamRequest או createVodStreamRequest. הוספת קוד הרשת מחילה את ההגדרות שנבחרו בממשק המשתמש של Ad Manager, כמו הפעלה של מודעות מוגבלות פרוגרמטיות. להצגת פודקאסטים ולחיבור של קטעי וידאו ב-Cloud, הוספת קוד הרשת מאפשרת לאתר את הסטרימינג ולהפעיל אותו. במאמר הזה מוסבר איך למצוא את קוד הרשת.
player		הטמעה של ממשק הנגן.
ppid		הוצא משימוש. משתמשים ב-adTagParameters. זה שינוי אופציונלי. מזהה שניתן על ידי בעל התוכן הדיגיטלי (PPID) של קהל ב-DFP.
streamActivityMonitorId		המזהה שישמש לניפוי באגים בזרם באמצעות כלי לניהול שידור (SAM). כך בעלי תוכן דיגיטלי יכולים למצוא יומן של שידור ביומן המעקב אחר פעילות השידור.
videoId		חובה בשידורים על פי דרישה. המזהה של מקור תוכן הסרטון.
videoObject		אובייקט הווידאו (כמו Video roSGNode) שאחראי להפעלת הסרטון באפליקציית הלקוח. האובייקט הזה ייבדק לקבלת נתונים שונים לצורך תזמון תקין של אירועי ID3 בשידור חי של HLS.
videoStitcherSessionOptions		אפשרויות הסשן משמשות להגדרת פרמטרים ספציפיים ל-VideoStitcher עבור בקשות stream של VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

החזרת ima.StreamRequest: אובייקט ima.StreamRequest עם מאפייני Live הנדרשים.

פרמטר	סוג	תיאור
assetKey	string
apiKey	string	פרמטר שמוקצה למאפיין ima.StreamRequest.apiKey של ima.StreamRequest המוחזר. אם אין מפתח API, מעבירים מחרוזת ריקה.
networkCode	string	קוד הרשת של בעל התוכן הדיגיטלי ששולח את הבקשה להעברת הנתונים. הוספת קוד הרשת היא אופציונלית, אבל מומלצת.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

הפונקציה מפעילה את המאפיינים הנדרשים של Pod Live ima.StreamRequest. שימוש ב-API הזה גורם להתעלמות מכל המאפיינים האחרים שספציפיים ל-ima.StreamType. אם אחד מהפרמטרים הנדרשים הוא מחרוזת ריקה, מתרחשת רישום ביומן שגיאות וה-API מחזיר StreamRequest כללי, בלי להתעלם ממאפיינים.

החזרת StreamRequest: אובייקט ima.StreamRequest עם המאפיינים הנדרשים של PodLive.

פרמטר	סוג	תיאור
customAssetKey	string
networkCode	string
apiKey	string	פרמטר אופציונלי שמוקצה למאפיין ima.StreamRequest.apiKey של ima.StreamRequest המוחזר. ברירת המחדל היא מחרוזת ריקה.

createPodVodStreamRequest(networkCode)

הפונקציה מפעילה את המאפיינים הנדרשים של ima.StreamRequest כדי לרשום שידור VOD כשמשתמשים בהצגת מודעות DAI ברצף עם כלי מיזוג וידאו של צד שלישי. הפונקציה הזו מגדירה את סוג הבקשה ל-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)

הפונקציה מפעילה את המאפיינים הנדרשים של VOD ב-Video Stitcher StreamRequest. השימוש ב-API הזה גורם למערכת להתעלם ממאפיינים אחרים ספציפיים ל-StreamType. אם אחד מהפרמטרים הנדרשים הוא מחרוזת ריקה, מתרחשת רישום ביומן שגיאות וה-API מחזיר StreamRequest כללי, בלי להתעלם ממאפיינים.

החזרת ima.StreamRequest: אובייקט ima.StreamRequest עם המאפיינים הנדרשים של VideoStitcherVod.

פרמטר	סוג	תיאור
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

הפונקציה מפעילה את המאפיינים הנדרשים של VOD ב-Video Stitcher‏ StreamRequest באמצעות vodConfigId שנוצר מ-Video Stitcher בענן. שימוש ב-API הזה גורם להתעלמות מכל נכס אחר שספציפי ל-StreamType. אם אחד מהפרמטרים הנדרשים הוא מחרוזת ריקה, מתרחשת רישום ביומן שגיאות וה-API מחזיר StreamRequest כללי, בלי להתעלם ממאפיינים.

החזרת ima.StreamRequest: אובייקט ima.StreamRequest עם המאפיינים הנדרשים של VideoStitcherVod.

פרמטר	סוג	תיאור
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

הפונקציה מפעילה את המאפיינים הנדרשים של ima.StreamRequest של VOD. השימוש ב-API הזה גורם להתעלמות מכל המאפיינים האחרים שספציפיים ל-ima.StreamType. אם אחד מהפרמטרים הנדרשים הוא מחרוזת ריקה, מתרחשת רישום ביומן שגיאות וה-API מחזיר StreamRequest כללי, בלי להתעלם ממאפיינים.

החזרת ima.StreamRequest: אובייקט ima.StreamRequest עם מאפייני VOD נדרשים.

פרמטר	סוג	תיאור
contentSourceId	string
videoId	string
apiKey	string	פרמטר שמוקצה למאפיין ima.StreamRequest.apiKey של ima.StreamRequest המוחזר. אם אין מפתח API, מעבירים מחרוזת ריקה.
networkCode	string	קוד הרשת של בעל התוכן הדיגיטלי ששולח את הבקשה להעברת הנתונים. הוספת קוד הרשת היא אופציונלית, אבל מומלצת.

חזרה למעלה

Class ima.StreamType

שדות

LIVE,‏VOD

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

מאפיינים

שם	סוג	תיאור
LIVE		הסרטון עלה לאוויר.
VOD		הסרטון זמין על פי דרישה.

חזרה למעלה

הכיתה ima.WrapperInfo

שדות

adId,‏adSystem,‏creativeAdId,‏creativeId,‏dealId

שיטות

createWrapperInfo

מכיל מידע על עטיפה.

מאפיינים

שם	סוג	תיאור
adId		המזהה של המודעה או מחרוזת ריקה אם המזהה לא ידוע.
adSystem		השם המוצהר של מערכת המודעות, או מחרוזת ריקה אם השם לא ידוע.
creativeAdId		מזהה המודעה בקריאייטיב או מחרוזת ריקה אם המזהה לא ידוע.
creativeId		המזהה של הקריאייטיב או מחרוזת ריקה אם המזהה לא ידוע.
dealId		מזהה הדיל או מחרוזת ריקה אם הוא לא ידוע.

createWrapperInfo()

הפונקציה מחזירה את הערך ima.WrapperInfo:

חזרה למעלה