SuperChatEvents: list

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

תרחישים נפוצים

שליחת בקשה

בקשת HTTP

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

הרשאה

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

היקף
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, שמציג את סכום הרכישה ואת המטבע של סופר צ'אט, בהתאם למוסכמות של שפה מסוימת. ערך הפרמטר חייב להיות קוד שפה הכלול ברשימה המוחזרת על ידי השיטה i18nLanguages.list. ערך ברירת המחדל הוא en, ופירוש הדבר הוא שהתנהגות ברירת המחדל היא לעצב את מחרוזות התצוגה כפי שהן ישמשו באנגלית. לדוגמה, מחרוזת מוגדרת כברירת מחדל כ-$1.00 ולא כ-$1,00.
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שיש להחזיר בקבוצת התוצאות. הערכים הקבילים הם 1 עד 50, כולל. ערך ברירת המחדל הוא 5.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שיש להחזיר. בתגובת API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שניתן לאחזור.

גוף הבקשה

אין להזין גוף בקשה בעת הפעלת שיטה זו.

תשובה

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

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

נכסים

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

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

שגיאות

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

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

רוצה לנסות?

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