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

Class ima

Methods

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

Methods

createAdBreakInfo

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

מאפיינים

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

createAdBreakInfo()

החזרות ima.AdBreakInfo:

חזרה למעלה

Class 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

Methods

createAdInfo

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

createAdInfo()

החזרות ima.AdInfo:

חזרה למעלה

Class ima.Companion

שדות

adSlotId, apiFramework, companionClickThrough, creativeType, height, trackingEvents, url, width

Methods

createCompanion

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

מאפיינים

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

createCompanion()

החזרות ima.Companion:

חזרה למעלה

Class ima.CuePoint

שדות

‫end, hasPlayed, start

Methods

createCuePoint

מכיל מידע על נקודת רמז.

מאפיינים

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

createCuePoint()

החזרות ima.CuePoint:

חזרה למעלה

Class ima.Error

שדות

id, info, type

Methods

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 שסופק.

חזרה למעלה

Class ima.Player

Methods

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

adBreakEnded(adBreakInfo)

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

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

adBreakStarted(adBreakInfo)

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

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

allVideoComplete()

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

createPlayer()

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

החזרות ima.Player:

loadUrl(streamInfo)

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

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

streamInitialized(streamInfo)

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

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

חזרה למעלה

Class ima.StreamFormat

שדות

‫DASH, HLS

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

מאפיינים

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

חזרה למעלה

Class ima.StreamInfo

שדות

format, manifest, streamId, streamType, subtitles

Methods

createStreamInfo

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

מאפיינים

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

createStreamInfo()

החזרות ima.StreamInfo:

חזרה למעלה

Class ima.StreamManager

Methods

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

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

addEventListener(event, callback)

מוסיף listener לאירוע שצוין. במאמר בנושא הקבוע 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)

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

החזרת 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)

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

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

replaceAdTagParameters(adTagParameters)

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

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

start()

התחלת ההפעלה של השידור.

חזרה למעלה

Class ima.StreamRequest

שדות

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

Methods

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

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

מאפיינים

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

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

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

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

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

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

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

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

createPodVodStreamRequest(networkCode)

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

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

פרמטר	סוג	תיאור
networkCode	string	קוד הרשת ב-Google Ad Manager

createStreamRequest()

‫
Returns 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)

מאתחל מאפיינים נדרשים של Video Stitcher VOD 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)

מאתחל מאפיינים נדרשים של Video Stitcher VOD 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)

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

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

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

חזרה למעלה

‫Class ima.StreamType

שדות

LIVE, VOD

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

מאפיינים

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

חזרה למעלה

Class ima.WrapperInfo

שדות

adId, adSystem, creativeAdId, creativeId, dealId

Methods

createWrapperInfo

מכיל מידע על wrapper.

מאפיינים

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

createWrapperInfo()

החזרות ima.WrapperInfo:

חזרה למעלה