Saat Anda membuat permintaan pertama untuk mengambil pesan chat, API akan menampilkan sebagian atau semua histori chat, bergantung pada panjang histori tersebut. Pesan dalam respons diurutkan dari yang terlama ke terbaru.
nextPageToken
dalam respons memberikan token yang, dalam permintaan Anda berikutnya, akan mengidentifikasi kumpulan hasil berikutnya yang harus diambil klien API Anda.- Properti
pollingIntervalMillis
menunjukkan berapa lama klien API Anda harus menunggu sebelum meminta hasil tambahan.
pageToken
ke nilai nextPageToken
dan server API akan menampilkan pesan chat tambahan, jika tersedia. Sekali lagi, dalam kumpulan hasil tersebut, pesan akan diurutkan dari yang terlama ke terbaru.Kasus penggunaan umum
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/liveChat/messages
Parameter
Tabel berikut mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.
Parameter | ||
---|---|---|
Parameter yang diperlukan | ||
liveChatId |
string Parameter liveChatId menentukan ID chat yang pesannya akan ditampilkan. ID live chat yang terkait dengan siaran ditampilkan di properti snippet.liveChatId resource liveBroadcast . |
|
part |
string Parameter part menentukan bagian resource liveChatMessage yang akan disertakan dalam respons API. Nilai yang didukung adalah id , snippet , dan authorDetails . |
|
Parameter opsional | ||
hl |
string Parameter hl menginstruksikan API untuk mengambil string tampilan mata uang yang dilokalkan untuk bahasa aplikasi tertentu yang didukung situs YouTube. Misalnya, dalam bahasa Inggris, mata uang akan ditampilkan sebagai $1.50 , tetapi dalam bahasa Prancis, mata uang akan ditampilkan sebagai 1,50$ .Nilai parameter harus berupa kode bahasa yang disertakan dalam daftar yang ditampilkan oleh metode i18nLanguages.list . |
|
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum pesan yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 200 hingga 2000 , inklusif. Nilai defaultnya adalah 500 . |
|
pageToken |
string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken mengidentifikasi halaman lain yang dapat diambil. |
|
profileImageSize |
unsigned integer Parameter profileImageSize menentukan ukuran foto profil pengguna yang harus ditampilkan dalam kumpulan hasil. Gambar berbentuk persegi. Nilai defaultnya adalah 88 , yang berarti gambar akan berukuran 88px kali 88px. Nilai yang dapat diterima berada dalam rentang 16 hingga 720 , inklusif. |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Respons
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage Resource ] }
Properti
Tabel berikut mendefinisikan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya akan berupa youtube#liveChatMessageListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya di kumpulan hasil. |
pollingIntervalMillis |
unsigned integer Jumlah waktu, dalam milidetik, yang mengharuskan klien menunggu sebelum melakukan polling lagi untuk pesan live chat baru. |
offlineAt |
datetime Tanggal dan waktu saat live stream yang mendasarinya offline. Properti ini hanya ada jika streaming sudah offline. Nilai ditentukan dalam format ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ). |
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 pesan. Setiap item dalam daftar adalah resource liveChatMessage . |
activePollItem |
object Data polling dalam pesan. Setiap polling adalah resource liveChatMessage dengan jenis pollEvent , yang mewakili polling aktif. Hanya boleh ada satu polling per chat. |
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) |
forbidden |
Anda tidak memiliki izin yang diperlukan guna mengambil pesan untuk live chat yang ditentukan. |
forbidden (403) |
liveChatDisabled |
Live chat tidak diaktifkan untuk siaran yang ditentukan. |
forbidden (403) |
liveChatEnded |
Live chat yang ditentukan tidak aktif lagi. |
notFound (404) |
liveChatNotFound |
Live chat yang ingin Anda ambil tidak dapat ditemukan. Periksa nilai parameter liveChatId permintaan untuk memastikan nilainya benar. |
rateLimitExceeded |
rateLimitExceeded |
Permintaan dikirim terlalu cepat setelah permintaan sebelumnya. Error ini terjadi saat permintaan API untuk mengambil pesan dikirim lebih sering daripada kecepatan refresh YouTube, sehingga menyia-nyiakan bandwidth. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.