LiveBroadcasts: transition

שינוי הסטטוס של שידור חי ב-YouTube והפעלת כל התהליכים המשויכים לסטטוס החדש. לדוגמה, כשמעבירים את הסטטוס של השידור ל-testing, המערכת של YouTube מתחילה לשדר וידאו בסטרימינג של השידור הזה. לפני שמתקשרים לשיטה הזו, צריך לוודא שהערך של המאפיין status.streamStatus של השידור שמשויך לשידור הוא active.

תרחישים נפוצים

שליחת בקשה

בקשת HTTP

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/transition

הרשאה

לבקשה הזו נדרשת הרשאה עם לפחות אחד מהיקפי ההרשאות הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

פרמטרים

הטבלה הבאה מפרטת את הפרמטרים שנתמכים על ידי שאילתה זו. כל הפרמטרים המפורטים הם פרמטרים של שאילתה.

פרמטרים
פרמטרים נדרשים
broadcastStatus	string הפרמטר broadcastStatus מזהה את המצב שאליו השידור משתנה. הערה: כדי להעביר שידור למצב testing או למצב live, הערך status.streamStatus חייב להיות active עבור השידור שאליו משויך השידור. ערכים קבילים: complete – השידור הסתיים. המערכת של YouTube מפסיקה לשדר סרטונים. live – השידור גלוי לקהל שלו. YouTube משדר וידאו לשידור הסטרימינג ולשידור שלו. testing – אפשר להתחיל לבדוק את השידור. YouTube משדר וידאו בשידור החי של השידור. לתשומת ליבך, ניתן להעביר שידור למצב testing רק אם נכס ה-contentDetails.monitorStream.enableMonitorStream שלו מוגדר ל-true.
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 רבים. היא מאפשרת לבעלי תוכן לאמת פעם אחת ולבצע פעולות מטעם הערוץ שצוין בערך הפרמטר, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ נפרד.

גוף הבקשה

אין להזין גוף בקשה בעת הפעלת שיטה זו.

תשובה

אם הצלחת, בשיטה הזו מוחזר משאב LiveBroadcast בגוף התגובה.

שגיאות

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

סוג השגיאה	פרטי השגיאה	תיאור
backendError	errorExecutingTransition	אירעה שגיאה במהלך שינוי הסטטוס של השידור.
forbidden (403)	errorStreamInactive	המעבר המבוקש אינו מותר כאשר הסטרימינג שמקושר לשידור אינו פעיל.
forbidden (403)	invalidTransition	לא ניתן להעביר את השידור החי מהסטטוס הנוכחי שלו לסטטוס הרצוי.
forbidden (403)	redundantTransition	השידור החי כבר נמצא בסטטוס המבוקש או מתבצע עיבוד לסטטוס המבוקש.
insufficientPermissions	insufficientLivePermissions	הבקשה אינה מורשית להעביר את השידור החי.
insufficientPermissions	livePermissionBlocked	בשלב זה, המשתמש שאישר את הבקשה לא יכול לצפות בווידאו בשידור חי ב-YouTube. בכתובת https://www.youtube.com/features אפשר למצוא פרטים על הסיבה לכך שהמשתמש לא יכול לשדר וידאו בשידור חי.
insufficientPermissions	liveStreamingNotEnabled	המשתמש שאישר את הבקשה לא מורשה לצפות בווידאו בשידור חי ב-YouTube. המשתמש יכול למצוא מידע נוסף בכתובת https://www.youtube.com/features.
notFound (404)	liveBroadcastNotFound	השידור שצוין באמצעות הפרמטר id לא קיים.
rateLimitExceeded (403)	userRequestsExceedRateLimit	המשתמש שלח יותר מדי בקשות בפרק זמן נתון.
required (400)	idRequired	הפרמטר הנדרש id חייב לזהות את השידור שאת הסטטוס שלו רוצים להעביר.
required (400)	statusRequired	בבקשת ה-API יש לציין ערך לפרמטר status.

רוצה לנסות?

אפשר להשתמש ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את בקשת ה-API ואת התשובה.