Menampilkan daftar thread komentar yang cocok dengan parameter permintaan API.
Dampak kuota: Panggilan ke metode ini memiliki biaya kuota 1 unit.
Kasus penggunaan umum
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/commentThreads
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 daftar yang dipisahkan koma dari satu atau beberapa properti resource commentThread yang akan disertakan dalam respons API.Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
|
|
Filter (sebutkan salah satu parameter berikut) | ||
allThreadsRelatedToChannelId |
string Parameter allThreadsRelatedToChannelId menginstruksikan API untuk menampilkan semua thread komentar yang terkait dengan saluran yang ditentukan. Responsnya dapat mencakup komentar tentang channel atau video di channel tersebut. |
|
channelId |
string Parameter channelId menginstruksikan API untuk menampilkan rangkaian komentar yang berisi komentar tentang channel yang ditentukan. (Respons tersebut tidak akan menyertakan komentar pada video yang diupload channel tersebut.) |
|
id |
string Parameter id menentukan daftar ID rangkaian komentar yang dipisahkan koma untuk resource yang harus diambil. |
|
videoId |
string Parameter videoId menginstruksikan API untuk menampilkan thread komentar yang terkait dengan ID video yang ditentukan. |
|
Parameter opsional | ||
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam set hasil.Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id . Nilai yang dapat diterima adalah 1 hingga 100 , inklusif. Nilai defaultnya adalah 20 . |
|
moderationStatus |
string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Setel parameter ini untuk membatasi rangkaian komentar yang dikembalikan ke status moderasi tertentu. Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id . Nilai defaultnya adalah published .Nilai yang dapat diterima adalah:
|
|
order |
string Parameter order menentukan urutan respons API yang harus mencantumkan thread komentar. Nilai yang valid adalah:
id .
|
|
pageToken |
string Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang harus ditampilkan. Di respons API, properti nextPageToken mengidentifikasi halaman hasil berikutnya yang dapat diambil.Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id . |
|
searchTerms |
string Parameter searchTerms menginstruksikan API untuk membatasi respons API agar hanya berisi komentar yang berisi istilah penelusuran tertentu.Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id . |
|
textFormat |
string Setel nilai parameter ini ke html atau plainText untuk menginstruksikan API agar menampilkan komentar dari pengguna dalam format html atau teks biasa. Nilai defaultnya adalah html .Nilai yang dapat diterima adalah:
|
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#commentThreadListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ commentThread Resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#commentThreadListResponse . |
etag |
etag Etag resource ini. |
nextPageToken |
string Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil. |
pageInfo |
object Objek pageInfo mengenkapsulasi informasi paging untuk kumpulan hasil. |
pageInfo.totalResults |
integer Total jumlah hasil dalam kumpulan hasil. |
pageInfo.resultsPerPage |
integer Jumlah hasil yang disertakan dalam respons API. |
items[] |
list Daftar rangkaian komentar 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 |
---|---|---|
badRequest (400) |
operationNotSupported |
Filter ID hanya kompatibel dengan komentar berdasarkan Google+. |
badRequest (400) |
processingFailure |
Server API gagal memproses permintaan. Meskipun ini adalah error sementara, biasanya ini menunjukkan bahwa input permintaan tidak valid. Periksa struktur resource commentThread dalam isi permintaan untuk memastikannya valid. |
forbidden (403) |
commentsDisabled |
Video yang diidentifikasi oleh parameter videoId telah menonaktifkan komentar. |
forbidden (403) |
forbidden |
Satu atau beberapa rangkaian komentar yang diminta tidak dapat diambil karena izin tidak memadai. Permintaan mungkin tidak diotorisasi dengan benar. |
notFound (404) |
channelNotFound |
Saluran yang diidentifikasi oleh parameter channelId atau allThreadsRelatedToChannelId tidak dapat ditemukan. |
notFound (404) |
commentThreadNotFound |
Satu atau beberapa rangkaian komentar yang ditentukan tidak dapat ditemukan. Periksa nilai parameter id permintaan untuk memastikan bahwa parameter tersebut sudah benar. |
notFound (404) |
videoNotFound |
Video yang diidentifikasi oleh parameter videoId tidak dapat ditemukan. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.