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

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

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

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

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

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-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.