מקשרים שידור ב-YouTube לשידור או מסירים קישור קיים בין השידור לבין השידור. ניתן לקשר שידור רק לזרם וידאו אחד, אך ייתכן ששידור וידאו יהיה מקושר ליותר משידור אחד.
תרחישים נפוצים לדוגמה
בקשה
בקשת HTTP
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/bind
אישור
בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
| היקף |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.
| פרמטרים | ||
|---|---|---|
| הפרמטרים הנדרשים | ||
id |
stringהפרמטר id מציין את המזהה הייחודי של השידור שמקשר לשידור וידאו. |
|
part |
stringהפרמטר part מציין רשימה מופרדת בפסיקים של מאפייני משאב liveBroadcast אחד או יותר שייכללו בתגובת ה-API. שמות part שאפשר לכלול בערך הפרמטר הם id, snippet, contentDetails ו-status. |
|
| פרמטרים אופציונליים | ||
onBehalfOfContentOwner |
stringניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של ההרשאה של הבקשה מזהים משתמש YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שהם הבעלים והמנהלים של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
onBehalfOfContentOwnerChannel |
stringניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית כראוי. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו מוסיפים את הסרטון. הפרמטר הזה נדרש כאשר בקשה מציינת ערך לפרמטר onBehalfOfContentOwner, ואפשר להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, יש לאשר את הבקשה באמצעות חשבון CMS שמקושר לבעלי התוכן בפרמטר onBehalfOfContentOwner. לבסוף, הערוץ שצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין.הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ומנהלים רבים ערוצי YouTube שונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ נפרד. |
|
streamId |
stringהפרמטר streamId מציין את המזהה הייחודי של שידור הווידאו שמשויך לשידור. אם הפרמטר הזה יושמט, ה-API יסיר את הקישור הקיים בין השידור לבין שידור הווידאו. |
|
גוף הבקשה
אין לציין את גוף הבקשה בקריאה לשיטה הזו.
תשובה
אם הפעולה בוצעה בהצלחה, השיטה מחזירה משאב של שידור חי בגוף התגובה.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שה-API עלול להחזיר בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במסמכים בנושא הודעת שגיאה.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
backendError |
internalError |
אירעה שגיאה פנימית במהלך הקישור. |
forbidden (403) |
liveBroadcastBindingNotAllowed |
הסטטוס הנוכחי של השידור החי לא מאפשר לקשר אותו לשידור. |
insufficientPermissions |
insufficientLivePermissions |
הבקשה לא מורשית לאחזר את השידור החי שצוין. מידע נוסף זמין במאמר הטמעה של אימות OAuth2. |
insufficientPermissions |
liveStreamingNotEnabled |
המשתמש שאישר את הבקשה אינו יכול להפעיל סטרימינג של וידאו בשידור חי ב-YouTube. המשתמשים יכולים למצוא מידע נוסף בכתובת https://www.youtube.com/features. |
notFound (404) |
liveBroadcastNotFound |
השידור שצוין על ידי הפרמטר id לא קיים. |
notFound (404) |
liveStreamNotFound |
הזרם שצוין על ידי הפרמטר streamId אינו קיים. |
rateLimitExceeded |
userRequestsExceedRateLimit |
המשתמש שלח יותר מדי בקשות בפרק זמן נתון. |
required (400) |
idRequired |
הפרמטר id הנדרש חייב לזהות את השידור לקישור. |
רוצה לנסות?
משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.