CommentThreads: list

Menampilkan daftar rangkaian komentar yang cocok dengan parameter permintaan API.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 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:
  • id
  • replies
  • snippet
Filter (tentukan salah satu parameter berikut)
allThreadsRelatedToChannelId string
Parameter allThreadsRelatedToChannelId menginstruksikan API untuk menampilkan semua rangkaian komentar yang terkait dengan channel tertentu.
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 rangkaian 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. Tetapkan parameter ini untuk membatasi rangkaian komentar yang ditampilkan ke status moderasi tertentu.

Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id. Nilai defaultnya adalah published.

Nilai yang dapat diterima adalah:
  • heldForReview – Mengambil rangkaian komentar yang menunggu peninjauan oleh moderator. Rangkaian komentar dapat disertakan dalam respons jika komentar tingkat teratas atau setidaknya salah satu balasan untuk komentar tersebut menunggu peninjauan.
  • likelySpam – Mengambil rangkaian komentar yang diklasifikasikan sebagai kemungkinan spam. Rangkaian komentar dapat disertakan dalam respons jika komentar tingkat teratas atau setidaknya salah satu balasan untuk komentar tersebut dianggap kemungkinan sebagai spam.
  • published – Mengambil rangkaian pesan komentar yang dipublikasikan. Nilai ini merupakan default. Rangkaian komentar dapat disertakan dalam respons jika komentar tingkat teratasnya telah dipublikasikan.
order string
Parameter order menentukan urutan respons API dalam mencantumkan rangkaian komentar. Nilai yang valid adalah:
  • time - Rangkaian komentar diurutkan berdasarkan waktu. Ini merupakan perilaku default.
  • relevance - Rangkaian komentar diurutkan berdasarkan relevansi.
Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam set hasil yang harus ditampilkan. Dalam 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 yang ditentukan.

Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id.
textFormat string
Tetapkan nilai parameter ini ke html atau plainText untuk menginstruksikan API agar menampilkan komentar yang ditinggalkan oleh pengguna dalam format html atau teks biasa. Nilai defaultnya adalah html.

Nilai yang dapat diterima adalah:
  • html – Menampilkan komentar dalam format HTML. Nilai ini merupakan default.
  • plainText – Menampilkan komentar dalam format teks biasa.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

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 set hasil.
pageInfo object
Objek pageInfo mengenkapsulasi informasi penomoran halaman 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 rangkaian komentar yang cocok dengan kriteria permintaan.

Error

Tabel berikut mengidentifikasi pesan error yang dapat ditampilkan API sebagai respons terhadap panggilan ke metode ini. Untuk mengetahui detail selengkapnya, lihat dokumentasi pesan error.

Jenis error Detail error Deskripsi
badRequest (400) operationNotSupported Filter id hanya kompatibel dengan komentar berdasarkan Google+.
badRequest (400) processingFailure Server API gagal memproses permintaan dengan berhasil. Meskipun error ini mungkin bersifat sementara, biasanya error ini menunjukkan bahwa input permintaan tidak valid. Periksa struktur resource commentThread dalam isi permintaan untuk memastikan bahwa resource tersebut 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 diizinkan dengan benar.
notFound (404) channelNotFound Channel yang diidentifikasi oleh parameter 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 nilai 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 API serta respons API.