GuideCategories: list

Catatan: Ini adalah pengumuman penghentian.

Resource guideCategories dan metode guideCategories.list tidak digunakan lagi mulai 9 September 2020.

Menampilkan daftar kategori yang dapat dikaitkan dengan channel YouTube.

Dampak kuota: Panggilan ke metode ini memiliki biaya kuota sebesar 1 unit.

Permintaan

Permintaan HTTP

GET https://www.googleapis.com/youtube/v3/guideCategories

Parameter

Tabel di bawah ini mencantumkan parameter yang didukung kueri ini. Semua parameter yang tercantum adalah parameter kueri.

Parameter
Parameter yang diperlukan
part string
Parameter part menentukan properti resource guideCategory yang akan disertakan dalam respons API. Setel nilai parameter ke snippet.
Filter (tentukan salah satu parameter berikut)
id string
Parameter id menentukan daftar yang dipisahkan koma yang berisi ID kategori channel YouTube untuk resource yang diambil. Di referensi guideCategory, properti id menentukan ID kategori channel YouTube.
regionCode string
Parameter regionCode menginstruksikan API untuk menampilkan daftar kategori panduan yang tersedia di negara yang ditentukan. Nilai parameternya adalah kode negara ISO 3166-1 alpha-2.
Parameter opsional
hl string
Parameter hl menentukan bahasa yang akan digunakan untuk nilai teks dalam respons API. Nilai defaultnya adalah en-US.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

Properti

Tabel berikut mendefinisikan properti yang muncul di resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya akan berupa youtube#guideCategoryListResponse.
etag etag
Etag resource ini.
nextPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya di kumpulan hasil.
prevPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya 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 kategori yang dapat dikaitkan dengan channel YouTube. Dalam peta ini, ID kategori adalah kunci peta, dan nilainya adalah resource guideCategory yang sesuai.

Error

Tabel di bawah ini 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
notFound (404) notFound Kategori panduan yang diidentifikasi oleh parameter id tidak dapat ditemukan. Gunakan metode guideCategories.list untuk mengambil daftar nilai yang valid.

Cobalah!

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