ההגדרה מחייבת את שידור 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 מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש CMS ב-YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון במערכת ניהול התוכן שהמשתמש מאמת באמצעותו חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
onBehalfOfContentOwnerChannel |
stringאפשר להשתמש בפרמטר הזה רק בבקשה מורשית. ניתן להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו רוצים להוסיף סרטון. הפרמטר הזה נדרש כשבקשה מציינת ערך לפרמטר onBehalfOfContentOwner, ואפשר להשתמש בו רק בשילוב עם הפרמטר. נוסף על כך, הבקשה חייבת לקבל הרשאה באמצעות חשבון CMS שמקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין. לסיום, הערוץ שערך הפרמטר onBehalfOfContentOwnerChannel מציין צריך להיות מקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין.הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי תוכן לאמת פעם אחת ולבצע פעולות מטעם הערוץ שצוין בערך הפרמטר, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ נפרד. |
|
streamId |
stringהפרמטר streamId מציין את המזהה הייחודי של שידור הווידאו שמקושר לשידור. אם לא תכללו את הפרמטר הזה, ה-API יסיר את הקישור הקיים בין השידור לבין וידאו בסטרימינג. |
|
גוף הבקשה
אין להזין גוף בקשה בעת הפעלת שיטה זו.
תשובה
אם הצלחת, בשיטה הזו מוחזר משאב LiveBroadcast בגוף התגובה.
שגיאות
הטבלה הבאה מזהה הודעות שגיאה שה-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 ואת התשובה.