SuperChatEvents: list

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 (baca selengkapnya tentang autentikasi dan otorisasi).

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 perilaku default-nya 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 kumpulan hasil. Nilai yang dapat diterima adalah 1 hingga 50, inklusif. Nilai defaultnya adalah 5.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan 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 mendefinisikan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan berupa youtube#superChatEventListResponse.
etag etag
Etag resource ini.
nextPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya di kumpulan hasil.
pageInfo object
Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan 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 detail selengkapnya.

Jenis error Detail error Deskripsi
forbidden (403) insufficientPermissions Permintaan tidak diizinkan dengan benar untuk mengambil peristiwa Super Chat.

Cobalah!

Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.