SuperChatEvents: list

הצגת רשימה של אירועי Super Chat משידורים חיים של ערוץ ב-30 הימים האחרונים.

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

בקשה

בקשת HTTP

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

אישור

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

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

פרמטרים

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

פרמטרים
פרמטרים נדרשים
part string
הפרמטר part מציין את חלקי המשאב superChatEvent שתגובת ה-API תכלול. הערכים הנתמכים הם id ו-snippet.
פרמטרים אופציונליים
hl string
הפרמטר hl מורה לשרת ה-API לעצב את ערך המאפיין snippet.displayString, שבו מוצגים סכום הרכישה והמטבע של Super Chat, בהתאם למוסכמות של שפה מסוימת. ערך הפרמטר חייב להיות קוד שפה שכלול ברשימה שמוחזרת על ידי השיטה i18nLanguages.list. ערך ברירת המחדל הוא en, כלומר התנהגות ברירת המחדל היא לעצב מחרוזות תצוגה כפי שהן ישמשו באנגלית. לדוגמה, כברירת מחדל, מחרוזת מפורמטת כ-$1.00 ולא כ-$1,00.
maxResults unsigned integer
הפרמטר maxResults מציין את המספר המקסימלי של פריטים שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 1 עד 50, כולל. ערך ברירת המחדל הוא 5.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתשובה של API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שאפשר לאחזר.

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

מאפיינים

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

מאפיינים
kind string
מזהה את סוג משאב ה-API. הערך יהיה youtube#superChatEventListResponse.
etag etag
ה-Etag של המשאב הזה.
nextPageToken string
האסימון שאפשר להשתמש בו כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.
pageInfo object
האובייקט pageInfo מכיל את פרטי הפיילוט של קבוצת התוצאות.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובה מה-API.
items[] list
רשימה של רכישות של Super Chat שתואמות לקריטריונים של הבקשה.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שיכולות להופיע בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במסמכים בנושא הודעות שגיאה.

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) insufficientPermissions הבקשה לא מורשית כראוי לאחזר אירועי Super Chat.

נסה בעצמך!

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