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.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-16 (שעון UTC).
[null,null,["עדכון אחרון: 2024-11-16 (שעון UTC)."],[],[],null,["# SuperChatEvents: list\n\nList Super Chat events from a channel's live streams in the previous 30 days.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/superChatEvents\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more about authentication and authorization, see [Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtube.readonly` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `superChatEvent` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `hl` | `string` The **hl** parameter instructs the API server to format the [snippet.displayString](/youtube/v3/live/docs/superChatEvents#snippet.displayString) property value, which shows the purchase amount and currency of a Super Chat, according to the conventions of a particular language. The parameter value must be a language code included in the list returned by the [i18nLanguages.list](/youtube/v3/docs/i18nLanguages/list) method. The default value is `en`, which means that the default behavior is to format display strings as they would be used in English. For example, by default, a string is formatted as `$1.00` rather than `$1,00`. |\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are `1` to `50`, inclusive. The default value is `5`. |\n| `pageToken` | `string` The **pageToken** parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` and `prevPageToken` properties identify other pages that could be retrieved. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#superChatEventListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n superChatEvent resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#superChatEventListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of Super Chat purchases that match the request criteria. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/live/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|-------------------|---------------------------|-----------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | The request is not properly authorized to retrieve Super Chat events. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
