מחזירה רשימה של שידורי YouTube שתואמים לפרמטרים של בקשת ה-API.
תרחישים נפוצים
בקשה
בקשת HTTP
GET https://www.googleapis.com/youtube/v3/liveBroadcasts
הרשאה
הבקשה הזו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
ההיקף |
---|
https://www.googleapis.com/auth/youtube.readonly |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים הנתמכים בשאילתה הזו. כל הפרמטרים הרשומים הם פרמטרים של שאילתות.
פרמטרים | ||
---|---|---|
פרמטרים נדרשים | ||
part |
string הפרמטר part מציין רשימה מופרדת בפסיקים של מאפיין משאב liveBroadcast אחד או יותר שייכללו בתגובת ה-API. שמות part שאפשר לכלול בערך הפרמטר הם id , snippet , contentDetails , monetizationDetails ו-status . |
|
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים) | ||
broadcastStatus |
string הפרמטר broadcastStatus מסנן את תגובת ה-API כך שיכלול רק שידורים בסטטוס שצוין.הערכים הקבילים הם:
|
|
id |
string הפרמטר id מציין רשימה של מזהי שידורים של YouTube שמופרדים בפסיקים, שמזהים את השידורים שמאוחזרים. במשאב liveBroadcast , המאפיין id מציין את מזהה השידור. |
|
mine |
boolean אפשר להשתמש בפרמטר mine כדי להורות ל-API להחזיר רק שידורים שבבעלות המשתמש המאומת. כדי לאחזר רק את השידורים שלך, צריך להגדיר את ערך הפרמטר כ-true . |
|
פרמטרים אופציונליים | ||
broadcastType |
string הפרמטר broadcastType מסנן את תגובת ה-API כך שיכלול רק שידורים מהסוג שצוין. צריך להשתמש בפרמטר הזה בבקשות שבהן הפרמטר mine מוגדר לערך true או עם הפרמטר broadcastStatus . ערך ברירת המחדל הוא event .הערכים הקבילים הם:
|
|
maxResults |
unsigned integer הפרמטר maxResults מציין את המספר המקסימלי של פריטים שרוצים להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50 , כולל. ערך ברירת המחדל הוא 5 . |
|
onBehalfOfContentOwner |
string ניתן להשתמש בפרמטר הזה רק בבקשה מורשית כהלכה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של הרשאת הבקשה מזהים משתמש YouTube CMS שפועל מטעם בעלי התוכן שצוינו בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ומנהלים ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
onBehalfOfContentOwnerChannel |
string ניתן להשתמש בפרמטר הזה רק בבקשה מורשית כהלכה. ניתן להשתמש בפרמטר הזה רק בבקשה מורשית כראוי. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו מתווסף סרטון. הפרמטר הזה נדרש כאשר בקשה מציינת ערך לפרמטר onBehalfOfContentOwner , וניתן להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, יש לאשר את הבקשה באמצעות חשבון מערכת ניהול תוכן המקושר לבעלי התוכן שצוין בפרמטר onBehalfOfContentOwner . לבסוף, הערוץ שצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שצוין בפרמטר onBehalfOfContentOwner .הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ובהם מנהלים ערוצי YouTube רבים ושונים. הוא מאפשר לבעלי תוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ נפרד. |
|
pageToken |
string הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובת API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שניתן לאחזר. |
תוכן הבקשה
אין לספק תוכן בקשה בקריאה לשיטה הזו.
תשובה
אם הפעולה מצליחה, השיטה הזו מחזירה גוף תגובה במבנה הבא:
{ "kind": "youtube#liveBroadcastListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveBroadcast Resource ] }
מאפיינים
בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:
מאפיינים | |
---|---|
kind |
string זהו הסוג של משאב ה-API. הערך יהיה youtube#liveBroadcastListResponse . |
etag |
etag ה-Etag של המשאב הזה. |
nextPageToken |
string האסימון שיכול לשמש כערך של הפרמטר pageToken לאחזור הדף הבא בקבוצת התוצאות. |
prevPageToken |
string האסימון שיכול לשמש כערך של הפרמטר pageToken לאחזור הדף הקודם בקבוצת התוצאות. |
pageInfo |
object באובייקט pageInfo יש אנקפסולציה של פרטי החלוקה לדפים של קבוצת התוצאות. |
pageInfo.totalResults |
integer המספר הכולל של התוצאות בקבוצת התוצאות. |
pageInfo.resultsPerPage |
integer מספר התוצאות שנכללו בתגובת ה-API. |
items[] |
list רשימת שידורים שעומדים בקריטריונים של הבקשה. |
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שה-API עשוי להחזיר בתגובה לקריאה לשיטה הזו. כדי לקבל פרטים נוספים, אפשר לעיין במסמכי התיעוד בנושא הודעת שגיאה.
סוג השגיאה | פרטי השגיאה | תיאור |
---|---|---|
insufficientPermissions |
insufficientLivePermissions |
הבקשה לא מורשית לאחזר את השידור החי. |
insufficientPermissions |
liveStreamingNotEnabled |
המשתמש שאישר את הבקשה לא יכול להפעיל סטרימינג של וידאו בשידור חי ב-YouTube. מידע נוסף זמין למשתמשים בכתובת https://www.youtube.com/features. |
רוצה לנסות?
צריך להשתמש בערך APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.