LiveBroadcasts: transition

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

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

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

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

גוף הבקשה

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

תשובה

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

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה ל-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 המשתמש שלח יותר מדי בקשות בפרק זמן נתון.
rateLimitExceeded (403) concurrentBroadcastsExceedLimit הערוץ כבר הגיע למספר המקסימלי של שידורים חיים בו-זמנית. צריך להפסיק שידור אחד או יותר שכבר משודרים בשידור חי כדי להתחיל שידור אחר בערוץ.
rateLimitExceeded (403) sharedIngestionBroadcastsExceedLimit בערוץ כבר יש את המספר המקסימלי של שידורים חיים שמשתמשים באותו מקור להטמעה. כדי להתחיל את השידור המבוקש, צריך להפסיק לפחות אחד מהשידורים האלה.
required (400) idRequired הפרמטר הנדרש id חייב לזהות את השידור שאת הסטטוס שלו רוצים לשנות.
required (400) statusRequired בבקשת ה-API צריך לציין ערך לפרמטר status.

רוצה לנסות?

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