LiveBroadcasts: control

הערה: השיטה liveBroadcasts.control הוצאה משימוש ותפסיק לפעול ב-1 באוקטובר 2020 או לאחר מכן. לאחר התאריך הזה, כל הקריאות לשיטה הזו יחזירו שגיאה אסורה (403), והשיטה תוסר מאוחר יותר לחלוטין.

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

המדיניות הזו קובעת את ההגדרות של slate שניתן להציג בשידור השידור.

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

בקשה

בקשת HTTP

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

אישור

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

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

פרמטרים

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

פרמטרים
הפרמטרים הנדרשים
id string
הפרמטר id מציין את מזהה השידור החי ב-YouTube שמזהה באופן ייחודי את השידור שבו מתבצע עדכון השקופית החוסמת.
part string
הפרמטר part מציין רשימה מופרדת בפסיקים של מאפייני משאב liveBroadcast אחד או יותר שייכללו בתגובת ה-API. שמות part שאפשר לכלול בערך הפרמטר הם id, snippet, contentDetails ו-status.
פרמטרים אופציונליים
displaySlate boolean
הפרמטר displaySlate מציין אם ה-Slate מופעל או מושבת.
offsetTimeMs unsigned long
הפרמטר offsetTimeMs מציין קיזוז זמן חיובי שבו יתרחש שינוי השקופית החוסמת שצוינה. הערך נמדד באלפיות שנייה מתחילת השידור המוניטור של השידור, כלומר הזמן שבו התחיל שלב הבדיקה של השידור. למרות שהוא מצוין באלפיות שנייה, הערך הוא למעשה אומדן, ומערכת YouTube משלים את הפעולה המבוקשת קרוב ככל האפשר לאותו זמן.

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

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

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

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

הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ומנהלים רבים ערוצי YouTube שונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ נפרד.
walltime datetime
הפרמטר walltime מציין את השעה של שעון הקיר שבה יתרחש שינוי הלוחות שצוין. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).

גוף הבקשה

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

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
backendError errorDisplaySlate אירעה שגיאה במהלך ביצוע הפעולה המבוקשת.
forbidden (403) liveBroadcastControlNotAllowed הפעולה המבוקשת מותרת רק אם סטטוס השידור הוא live.
insufficientPermissions insufficientLivePermissions המשתמש לא מורשה לבצע את הפעולה המבוקשת, כנראה בגלל שלמשתמש אין הרשאה לשדר סטרימינג בשידור חי.
insufficientPermissions liveStreamingNotEnabled המשתמש שאישר את הבקשה אינו יכול להפעיל סטרימינג של וידאו בשידור חי ב-YouTube. המשתמשים יכולים למצוא מידע נוסף בכתובת https://www.youtube.com/features.
invalidValue (400) conflictingTimeFields ניתן לציין רק אחד מהערכים offsetTimeMs ו-walltime.
invalidValue (400) invalidOffsetTimeMs ערך הפרמטר offsetTimeMs אינו חוקי. ערך הפרמטר חייב להיות חיובי, אבל ניתן לציין את הפרמטר רק אם זרם המעקב של השידור מופעל.
invalidValue (400) invalidWalltime ערך הפרמטר walltime אינו חוקי.
notFound (404) liveBroadcastNotFound השידור שצוין על ידי הפרמטר id לא קיים.
required (400) actionRequired בקשת ה-API צריכה לציין פעולה אחת לפחות. בשלב זה, הפעולה הנתמכת היחידה היא להפעיל או להשבית את השקופית החוסמת.
required (400) idRequired הפרמטר id הנדרש חייב לזהות את השידור שמתעדכן.

רוצה לנסות?

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