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

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

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

גוף הבקשה

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

תשובה

אם הפעולה בוצעה ללא שגיאות, ה-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 יכול להחזיר בתגובה לקריאה ל-method הזה. פרטים נוספים זמינים בהודעת השגיאה.

סוג השגיאה פרטי השגיאה תיאור
insufficientPermissions insufficientLivePermissions אין הרשאה לבקשה לאחזר את השידור החי.
insufficientPermissions liveStreamingNotEnabled המשתמש שאישר את הבקשה לא מורשה לשדר וידאו בשידור חי ב-YouTube. מידע נוסף זמין במאמר זכאות לשימוש בתכונות.

רוצה לנסות?

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