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