Channels: list

Catatan: Nilai properti channel resource's statistics.subscriberCount telah diperbarui untuk mencerminkan perubahan kebijakan YouTube yang memengaruhi cara jumlah subscriber ditampilkan. Untuk mengetahui informasi selengkapnya, lihat Histori Revisi atau Pusat Bantuan YouTube.

Menampilkan koleksi nol atau lebih resource channel yang cocok dengan kriteria permintaan.

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

Kasus penggunaan umum

Permintaan

Permintaan HTTP

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

Otorisasi

Permintaan yang mengambil bagian auditDetails untuk resource channel harus memberikan token otorisasi yang berisi cakupan https://www.googleapis.com/auth/youtubepartner-channel-audit. Selain itu, token apa pun yang menggunakan cakupan tersebut harus dicabut saat MCN memutuskan untuk menerima atau menolak channel atau dalam waktu dua minggu sejak tanggal token dikeluarkan.

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 channel yang akan disertakan dalam respons API.

Jika parameter mengidentifikasi properti yang berisi properti turunan, properti turunan akan disertakan dalam respons. Misalnya, dalam resource channel, properti contentDetails berisi properti lain, seperti properti uploads. Dengan demikian, jika Anda menetapkan part=contentDetails, respons API juga akan berisi semua properti bertingkat tersebut.

Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filter (tentukan tepat satu parameter berikut)
categoryId string
Parameter ini tidak digunakan lagi. Parameter categoryId menentukan kategori panduan YouTube dan dapat digunakan untuk meminta channel YouTube yang terkait dengan kategori tersebut.
forHandle string
Parameter forHandle menentukan nama sebutan akun YouTube, sehingga meminta channel yang terkait dengan nama sebutan akun tersebut. Nilai parameter dapat diawali dengan simbol @. Misalnya, untuk mengambil resource untuk channel "Google for Developers", tetapkan nilai parameter forHandle ke GoogleDevelopers atau @GoogleDevelopers.
forUsername string
Parameter forUsername menentukan nama pengguna YouTube, sehingga meminta channel yang terkait dengan nama pengguna tersebut.
id string
Parameter id menentukan daftar yang dipisahkan koma dari ID channel YouTube untuk resource yang diambil. Dalam resource channel, properti id menentukan ID channel YouTube.
managedByMe boolean
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.

Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Tetapkan nilai parameter ini ke true untuk menginstruksikan API agar hanya menampilkan channel yang dikelola oleh pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner. Pengguna harus diautentikasi sebagai akun CMS yang ditautkan ke pemilik konten yang ditentukan dan onBehalfOfContentOwner harus diberikan.
mine boolean
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar. Tetapkan nilai parameter ini ke true untuk menginstruksikan API agar hanya menampilkan channel yang dimiliki oleh pengguna yang diautentikasi.
Parameter opsional
hl string
Parameter hl menginstruksikan API untuk mengambil metadata resource yang dilokalkan untuk bahasa aplikasi tertentu yang didukung situs YouTube. Nilai parameter harus berupa kode bahasa yang disertakan dalam daftar yang ditampilkan oleh metode i18nLanguages.list.

Jika detail resource yang dilokalkan tersedia dalam bahasa tersebut, objek snippet.localized resource akan berisi nilai yang dilokalkan. Namun, jika detail yang dilokalkan tidak tersedia, objek snippet.localized akan berisi detail resource dalam bahasa default resource.
maxResults unsigned integer
Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam kumpulan hasil. Nilai yang dapat diterima adalah 0 hingga 50, inklusif. Nilai default-nya adalah 5.
onBehalfOfContentOwner string
Parameter ini hanya dapat digunakan dalam permintaan yang diotorisasi dengan benar.

Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube.

Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna YouTube CMS yang bertindak atas nama pemilik konten yang ditentukan dalam parameter value. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola banyak channel YouTube yang berbeda. Parameter ini memungkinkan pemilik konten melakukan autentikasi satu kali dan mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang digunakan pengguna untuk melakukan autentikasi harus ditautkan ke pemilik konten YouTube yang ditentukan.
pageToken string
Parameter pageToken mengidentifikasi halaman tertentu dalam kumpulan hasil yang harus ditampilkan. Dalam respons API, properti nextPageToken dan prevPageToken mengidentifikasi halaman lain yang dapat diambil.

Isi permintaan

Jangan berikan isi permintaan saat memanggil metode ini.

Respons

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

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

Properti

Tabel berikut menentukan properti yang muncul dalam resource ini:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah youtube#channelListResponse.
etag etag
Etag resource ini.
nextPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman berikutnya dalam kumpulan hasil.
prevPageToken string
Token yang dapat digunakan sebagai nilai parameter pageToken untuk mengambil halaman sebelumnya dalam kumpulan hasil. Perhatikan bahwa properti ini tidak disertakan dalam respons API jika permintaan API yang sesuai menetapkan parameter managedByMe ke true.
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 channel 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 YouTube Data API - Error.

Jenis error Detail error Deskripsi
badRequest (400) invalidCriteria Maksimum satu filter berikut dapat ditentukan:id, categoryId, mine, managedByMe, forHandle, forUsername. Jika autentikasi pemilik konten melalui parameter onBehalfOfContentOwner, hanya id atau managedByMe yang dapat ditentukan.
forbidden (403) channelForbidden Channel yang ditentukan oleh parameter id tidak mendukung permintaan atau permintaan tidak diotorisasi dengan benar.
notFound (404) categoryNotFound Kategori yang diidentifikasi oleh parameter categoryId tidak dapat ditemukan. Gunakan metode guideCategories.list untuk mengambil daftar nilai yang valid.
notFound (404) channelNotFound Channel yang ditentukan dalam parameter id tidak dapat ditemukan.

Cobalah!

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