LiveBroadcasts: list

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

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

בקשה

בקשת HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

אישור

הבקשה הזו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים. למידע נוסף מידע על אימות והרשאה, ראו הטמעת אימות OAuth 2.0.

היקף
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 כך שתכלול רק שידורים עם הסטטוס שצוין.

הערכים הקבילים הם:
  • active – החזרת השידורים החיים הנוכחיים.
  • all – החזרת כל השידורים.
  • completed – החזרת שידורים שכבר הסתיימו.
  • upcoming – החזרת שידורים שעדיין לא התחילו.
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי שידורים ב-YouTube שמזהים את השידורים שמאוחזרים. במשאב liveBroadcast, המאפיין id מציין את מזהה השידור.
mine boolean
ניתן להשתמש בפרמטר mine כדי להורות ל-API להחזיר רק שידורים שבבעלות המשתמש המאומת. כדי לאחזר רק את השידורים שלכם, צריך להגדיר את ערך הפרמטר ל-true.
פרמטרים אופציונליים
broadcastType string
הפרמטר broadcastType מסנן את תגובת ה-API כך שתכלול רק שידורים מהסוג שצוין. צריך להשתמש בפרמטר בבקשות המגדירות את הפרמטר mine ל-true או שמשתמשות בפרמטר broadcastStatus. ערך ברירת המחדל הוא event.

הערכים הקבילים הם:
  • all – החזרת כל השידורים.
  • event – החזרת רק שידורים של אירועים מתוזמנים.
  • persistent – החזרת שידורים קבועים בלבד.
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50, כולל. ערך ברירת המחדל הוא 5.
onBehalfOfContentOwner string
ניתן להשתמש בפרמטר הזה רק בבקשה מורשית תקינה.
הערה: הפרמטר הזה מיועד לשותפי תוכן של YouTube בלבד.

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

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

הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ובניהולם של ערוצי YouTube רבים ושונים. הוא מאפשר לבעלי תוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, בלי שיצטרכו לספק פרטי כניסה לאימות לכל ערוץ נפרד.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובה מ-API, הנכסים nextPageToken ו-prevPageToken מזהים דפים אחרים שאפשר לאחזר.

גוף הבקשה

אין לספק גוף בקשה כשמבצעים קריאה ל-method הזה.

תשובה

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

{
  "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. מידע נוסף זמין במאמר סטטוס הפעלת תכונות.

נסה בעצמך!

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