Comments: list

Menampilkan daftar 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/comments

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 properti resource comment yang dipisahkan koma dan akan disertakan dalam respons API.

Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
  • id
  • snippet
Filter (tentukan tepat satu parameter berikut)
id string
Parameter id menentukan daftar ID komentar yang dipisahkan koma untuk resource yang diambil. Dalam resource comment, properti id menentukan ID komentar.
parentId string
Parameter parentId menentukan ID komentar yang akan diambil balasannya.

Catatan: YouTube saat ini hanya mendukung balasan untuk komentar tingkat atas. Namun, balasan untuk balasan mungkin akan didukung di masa mendatang.
Parameter opsional
maxResults unsigned integer
Parameter maxResults menentukan jumlah maksimum item yang akan ditampilkan dalam kumpulan hasil.

Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id. Nilai yang dapat diterima adalah 1 hingga 100, inklusif. Nilai default-nya adalah 20.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang akan ditampilkan. Dalam respons API, properti nextPageToken mengidentifikasi halaman hasil berikutnya yang dapat diambil.

Catatan: Parameter ini tidak didukung untuk digunakan bersama dengan parameter id.
textFormat string
Parameter ini menunjukkan apakah API harus menampilkan komentar yang diformat sebagai HTML atau sebagai teks biasa. Nilai default-nya 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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah youtube#commentListResponse.
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 merangkum informasi penomoran halaman 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 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+.
forbidden (403) forbidden Satu atau beberapa komentar yang diminta tidak dapat diambil karena izin tidak memadai. Permintaan mungkin tidak diotorisasi dengan benar.
notFound (404) commentNotFound Satu atau beberapa komentar yang ditentukan tidak dapat ditemukan. Periksa nilai parameter id dan parentId permintaan untuk memastikan nilai tersebut benar.

Cobalah!

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