LiveStreams: list

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

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

בקשה

בקשת HTTP

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

אישור

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

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

פרמטרים

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

פרמטרים
פרמטרים נדרשים
part	string הפרמטר part מציין רשימה מופרדת בפסיקים של מאפיין אחד או יותר של משאב liveStream שהתגובה מה-API תכלול. השמות part שאפשר לכלול בערך הפרמטר הם id,‏ snippet,‏ cdn ו-status.
מסננים (צריך לציין בדיוק אחד מהפרמטרים הבאים)
id	string הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי מקורות נתונים ב-YouTube, שמזהים את מקורות הנתונים שאותם מאחזרים. במשאב liveStream, המאפיין id מציין את מזהה השידור.
mine	boolean אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. אפשר להשתמש בפרמטר mine כדי להנחות את ה-API להחזיר רק סטרימינג בבעלות המשתמש המאומת. כדי לאחזר רק את הזרמים שלכם, מגדירים את ערך הפרמטר ל-true.
פרמטרים אופציונליים
maxResults	unsigned integer הפרמטר maxResults מציין את המספר המקסימלי של פריטים שיוחזרו בקבוצת התוצאות. הערכים הקבילים הם בין 0 ל-50, כולל. ערך ברירת המחדל הוא 5.
onBehalfOfContentOwner	string אפשר להשתמש בפרמטר הזה רק בבקשה מורשית כראוי. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי ההרשאה של הבקשה מזהים משתמש ב-YouTube CMS שפועל בשם בעל התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן ב-YouTube שהם הבעלים של ערוצי YouTube רבים ומנהלים אותם. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי כניסה לאימות לכל ערוץ בנפרד. החשבון במערכת ניהול התוכן שהמשתמש מאמת צריך להיות מקושר לבעל התוכן ב-YouTube שצוין.
onBehalfOfContentOwnerChannel	string אפשר להשתמש בפרמטר הזה רק בבקשה מורשית כראוי. אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube. הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה הערוץ ב-YouTube שאליו מתווסף סרטון. הפרמטר הזה נדרש כשבקשה מציינת ערך לפרמטר onBehalfOfContentOwner, ואפשר להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, צריך לאשר את הבקשה באמצעות חשבון במערכת ניהול התוכן שמקושר לבעל התוכן שמוגדר בפרמטר onBehalfOfContentOwner. בנוסף, הערוץ שצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שצוינו בפרמטר onBehalfOfContentOwner. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם ערוצי YouTube רבים ושונים. הוא מאפשר לבעלי התוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, בלי לספק פרטי כניסה לאימות לכל ערוץ בנפרד.
pageToken	string הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובה מה-API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שאפשר לאחזר.

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#liveStreamListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveStream Resource
  ]
}

מאפיינים

בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:

מאפיינים
kind	‫string מזהה את סוג משאב ה-API. הערך יהיה youtube#liveStreamListResponse.
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. מידע נוסף זמין בכתובת https://www.youtube.com/features.

רוצה לנסות?

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