SuperChatEvents: list
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mencantumkan peristiwa Super Chat dari live stream channel dalam 30 hari sebelumnya.
Kasus penggunaan umum
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/superChatEvents
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut. Untuk membaca selengkapnya tentang autentikasi dan otorisasi, lihat Menerapkan autentikasi OAuth 2.0.
| Cakupan |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
Parameter
Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.
| Parameter |
| Parameter yang diperlukan |
part |
string
Parameter part menentukan bagian resource superChatEvent yang akan disertakan dalam respons API. Nilai yang didukung adalah id dan snippet. |
| Parameter opsional |
hl |
string
Parameter hl menginstruksikan server API untuk memformat nilai properti snippet.displayString, yang menampilkan jumlah pembelian dan mata uang Super Chat, sesuai dengan konvensi bahasa tertentu. Nilai parameter harus berupa kode bahasa yang disertakan dalam daftar yang ditampilkan oleh metode i18nLanguages.list. Nilai defaultnya adalah en, yang berarti bahwa perilaku defaultnya adalah memformat string tampilan seperti yang akan digunakan dalam bahasa Inggris. Misalnya, secara default, string diformat sebagai $1.00, bukan $1,00. |
maxResults |
unsigned integer
Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam set hasil. Nilai yang dapat diterima adalah 1 hingga 50, inklusif. Nilai defaultnya adalah 5. |
pageToken |
string
Parameter pageToken mengidentifikasi halaman tertentu dalam set hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken dan prevPageToken mengidentifikasi halaman lain yang dapat diambil. |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Respons
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{
"kind": "youtube#superChatEventListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
superChatEvent resource
]
}
Properti
Tabel berikut menentukan properti yang muncul dalam resource ini:
| Properti |
kind |
string
Mengidentifikasi jenis resource API. Nilainya akan menjadi youtube#superChatEventListResponse. |
etag |
etag
Etag resource ini. |
nextPageToken |
string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam set hasil. |
pageInfo |
object
Objek pageInfo mengenkapsulasi informasi paging untuk set hasil. |
pageInfo.totalResults |
integer
Jumlah total hasil dalam kumpulan hasil. |
pageInfo.resultsPerPage |
integer
Jumlah hasil yang disertakan dalam respons API. |
items[] |
list
Daftar pembelian Super Chat yang cocok dengan kriteria permintaan. |
Error
Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Lihat dokumentasi pesan error untuk mengetahui detail selengkapnya.
| Jenis error |
Detail error |
Deskripsi |
forbidden (403) |
insufficientPermissions |
Permintaan tidak diberi otorisasi dengan benar untuk mengambil peristiwa Super Chat. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan serta respons API.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-11-16 UTC.
[null,null,["Terakhir diperbarui pada 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."]]
