סיווג: StreamRequest

‪ima.StreamRequest

class   static

יצרן

StreamRequest

new StreamRequest()

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

מאפיינים

adTagParameters

static

מחרוזת

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

adUiNode

static

roSGNode

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

apiKey

static

מחרוזת

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

assetKey

static

מחרוזת

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

authToken

static

מחרוזת

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

contentSourceId

static

מחרוזת

חובה לשידורים לפי דרישה. הערך של cmsid מגיע ממקור תוכן הווידאו של DFP בממשק המשתמש של DFP.

customAssetKey

static

מחרוזת

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

פורמט

static

ima.StreamFormat

הפורמט של הסטרימינג. ברירת המחדל היא ima.StreamFormat.HLS.

networkCode

static

מחרוזת

קוד הרשת של בעל התוכן הדיגיטלי ששולח את בקשת השידור. קודים של רשתות נדרשים לבקשות של שידורים להצגת מודעות מסוג Pod שנוצרו באמצעות createPodLiveStreamRequest או createPodVodStreamRequest. הקודים האלה נדרשים גם לבקשות של Cloud stitching stream שנוצרות באמצעות createVideoStitcherLiveStreamRequest,‏ createVideoStitcherVodStreamRequest או createVideoStitcherVodStreamRequestWithVodConfig. הקודים האלה הם אופציונליים, אבל מומלץ להשתמש בהם בבקשות לשידורי Full service שנוצרו באמצעות createLiveStreamRequest או createVodStreamRequest. הוספת קוד הרשת מחיל את ההגדרות שנבחרו בממשק המשתמש של Ad Manager, כמו הפעלת מודעות מוגבלות פרוגרמטיות. במקרים של הצגת מודעות ב-Pod וחיבור של Cloud, הוספת קוד הרשת מאתרת את הסטרימינג ומפעילה אותו. במאמר הזה מוסבר איך למצוא את קוד הרשת.

שחקן

static

‫(ima.Player או Invalid)

הטמעה של ממשק הנגן.

ppid

static

מחרוזת

הוצא משימוש. משתמשים ב-adTagParameters. אופציונלי. קהל ב-DFP מזהה שניתן על ידי בעל התוכן הדיגיטלי.

streamActivityMonitorId

static

מחרוזת

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

videoId

static

מחרוזת

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

videoObject

static

(roVideo או Invalid)

אובייקט הסרטון (כמו Video roSGNode) שאחראי להפעלת הסרטון באפליקציית הלקוח. המערכת תבצע סקר של האובייקט הזה כדי לקבל נתונים שייעזרו בתזמון נכון של אירועי ID3 של HLS בשידור חי.

videoStitcherSessionOptions

static

‫Array of V

אפשרויות הסשן משמשות להגדרת פרמטרים ספציפיים של VideoStitcher עבור streamRequests.

Methods

createLiveStreamRequest

static

‫createLiveStreamRequest(assetKey, apiKey, networkCode) returns ima.StreamRequest

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

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

החזרות

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

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) returns StreamRequest

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

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

החזרות

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

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) returns StreamRequest

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

פרמטר
networkCode	מחרוזת קוד הרשת ב-Google Ad Manager

החזרות

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

createStreamRequest

static

‫createStreamRequest() מחזירה ima.StreamRequest

החזרות

‫ima.StreamRequest אובייקט ima.StreamRequest ריק.

createVideoStitcherLiveStreamRequest

static

‫createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) מחזירה ima.StreamRequest

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

פרמטר
customAssetKey	מחרוזת
networkCode	מחרוזת
liveConfigId	מחרוזת
אזור	מחרוזת
projectNumber	מחרוזת
oAuthToken	מחרוזת

החזרות

ima.StreamRequest ima.StreamRequest אובייקט עם מאפייני החובה של VideoStitcherLive.

createVideoStitcherVodStreamRequest

static

‫createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) returns ima.StreamRequest

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

פרמטר
adTagUrl	מחרוזת
networkCode	מחרוזת
contentSourceUrl	מחרוזת
אזור	מחרוזת
projectNumber	מחרוזת
oAuthToken	מחרוזת

החזרות

‫ima.StreamRequest ima.StreamRequest אובייקט עם מאפייני VideoStitcherVod נדרשים.

createVideoStitcherVodStreamRequestWithVodConfig

static

‫createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) returns ima.StreamRequest

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

פרמטר
vodConfigId	מחרוזת
networkCode	מחרוזת
אזור	מחרוזת
projectNumber	מחרוזת
oAuthToken	מחרוזת

החזרות

‫ima.StreamRequest ima.StreamRequest אובייקט עם מאפייני VideoStitcherVod נדרשים.

createVodStreamRequest

static

‪createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) returns ima.StreamRequest

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

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

החזרות

אובייקט ima.StreamRequest ima.StreamRequest עם מאפייני VOD נדרשים.