הערה: השיטה
הלקוחות עדיין יכולים ליישם את מבחר הסרטונים שלהם על ידי הוספת שכבת-על לסרטון שנשלח לשרתי הטמעת הנתונים של YouTube. הודעה על הוצאה משימוש
liveBroadcasts.control הוצאה משימוש ותפסיק לפעול ב-1 באוקטובר 2020. אחרי התאריך הזה, כל הקריאות לשיטה הזו יחזירו שגיאה אסורה (403), ומאוחר יותר השיטה
תוסר לחלוטין.הלקוחות עדיין יכולים ליישם את מבחר הסרטונים שלהם על ידי הוספת שכבת-על לסרטון שנשלח לשרתי הטמעת הנתונים של YouTube. הודעה על הוצאה משימוש
הגדרה זו קובעת את ההגדרות של השקופית החוסמת שניתן להציג בשידור.
תרחישים נפוצים
שליחת בקשה
בקשת 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 מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש CMS ב-YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון במערכת ניהול התוכן שהמשתמש מאמת באמצעותו חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
onBehalfOfContentOwnerChannel |
stringאפשר להשתמש בפרמטר הזה רק בבקשה מורשית. ניתן להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו רוצים להוסיף סרטון. הפרמטר הזה נדרש כשבקשה מציינת ערך לפרמטר onBehalfOfContentOwner, ואפשר להשתמש בו רק בשילוב עם הפרמטר. נוסף על כך, הבקשה חייבת לקבל הרשאה באמצעות חשבון CMS שמקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין. לסיום, הערוץ שערך הפרמטר onBehalfOfContentOwnerChannel מציין צריך להיות מקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין.הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי תוכן לאמת פעם אחת ולבצע פעולות מטעם הערוץ שצוין בערך הפרמטר, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ נפרד. |
|
walltime |
datetimeהפרמטר walltime מציין את השעה בשעון הקיר שבה תתבצע החלפת הסליל שצוינה. הערך צוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ). |
|
גוף הבקשה
אין להזין גוף בקשה בעת הפעלת שיטה זו.
תשובה
אם הצלחת, בשיטה הזו מוחזר משאב LiveBroadcast בגוף התגובה.
שגיאות
הטבלה הבאה מזהה הודעות שגיאה שה-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 ואת התשובה.