LiveBroadcasts: transition

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

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

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

אישור

הבקשה הזו דורשת הרשאה עם לפחות אחד מההיקפים הבאים. למידע נוסף על אימות והרשאה, קראו את המאמר הטמעת אימות OAuth 2.0.

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

הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו מתווסף סרטון. הפרמטר הזה נדרש כשבבקשה מצוין ערך לפרמטר onBehalfOfContentOwner, וניתן להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, צריך לאשר את הבקשה באמצעות חשבון מערכת ניהול תוכן שמקושר לבעלי התוכן שמצוין בפרמטר onBehalfOfContentOwner. לבסוף, הערוץ שמצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שמצוין בערך הפרמטר onBehalfOfContentOwner.

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

גוף הבקשה

אין לספק גוף בקשה בקריאה ל-method הזה.

תשובה

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

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שיכולות להופיע בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במאמר YouTube Live Streaming API – שגיאות.

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

נסה בעצמך!

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