Menampilkan kumpulan playlist yang cocok dengan parameter permintaan API. Misalnya, Anda dapat mengambil semua playlist yang dimiliki pengguna terautentikasi, atau Anda dapat mengambil satu atau beberapa playlist menurut ID uniknya.
Dampak kuota: Panggilan ke metode ini memiliki biaya kuota 1 unit.
Kasus penggunaan umum
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/youtube/v3/playlists
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 playlist yang akan disertakan dalam respons API.Jika parameter mengidentifikasi properti yang berisi properti turunan, properti turunan akan disertakan dalam respons. Misalnya, dalam resource playlist , properti snippet berisi properti seperti author , title , description , dan timeCreated . Dengan demikian, jika Anda menyetel part=snippet , respons API akan berisi semua properti tersebut.Daftar berikut berisi nama part yang dapat Anda sertakan dalam nilai parameter:
|
|
Filter (sebutkan salah satu parameter berikut) | ||
channelId |
string Nilai ini menunjukkan bahwa API hanya boleh menampilkan playlist channel yang ditentukan. |
|
id |
string Parameter id menentukan daftar yang dipisahkan koma dari ID playlist YouTube untuk resource yang sedang diambil. Dalam resource playlist , properti id menentukan ID playlist YouTube playlist. |
|
mine |
boolean Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Setel nilai parameter ini ke true untuk menginstruksikan API agar hanya menampilkan playlist yang dimiliki oleh pengguna terautentikasi. |
|
Parameter opsional | ||
hl |
string Parameter hl menginstruksikan API untuk mengambil metadata resource yang dilokalkan untuk bahasa aplikasi tertentu yang didukung oleh 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 defaultnya adalah 5 . |
|
onBehalfOfContentOwner |
string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Catatan: Parameter ini ditujukan secara eksklusif untuk partner konten YouTube. Parameter onBehalfOfContentOwner menunjukkan bahwa kredensial otorisasi permintaan mengidentifikasi pengguna CMS YouTube yang bertindak atas nama pemilik konten yang ditentukan dalam nilai parameter. Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali serta mendapatkan akses ke semua data video dan channel mereka, tanpa harus memberikan kredensial autentikasi untuk setiap channel. Akun CMS yang diautentikasi pengguna harus ditautkan dengan pemilik konten YouTube yang ditentukan. |
|
onBehalfOfContentOwnerChannel |
string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Catatan: Parameter ini ditujukan khusus untuk partner konten YouTube. Parameter onBehalfOfContentOwnerChannel menentukan ID channel YouTube dari channel yang menjadi tujuan penambahan video. Parameter ini diperlukan saat permintaan menentukan nilai untuk parameter onBehalfOfContentOwner , dan hanya dapat digunakan bersama parameter tersebut. Selain itu, permintaan tersebut harus diotorisasi menggunakan akun CMS yang ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner . Terakhir, channel yang ditentukan oleh parameter value onBehalfOfContentOwnerChannel harus ditautkan ke pemilik konten yang ditentukan oleh parameter onBehalfOfContentOwner .Parameter ini ditujukan untuk partner konten YouTube yang memiliki dan mengelola berbagai channel YouTube. Dengan kebijakan ini, pemilik konten dapat mengautentikasi sekali dan melakukan tindakan atas nama saluran yang ditentukan dalam nilai parameter, tanpa harus memberikan kredensial autentikasi untuk setiap saluran terpisah. |
|
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.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#playlistListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlist Resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#playlistListResponse . |
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. |
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 playlist 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 |
---|---|---|
forbidden (403) |
channelClosed |
Saluran yang ditentukan dalam parameter channelId telah ditutup. |
forbidden (403) |
channelSuspended |
Saluran yang ditentukan dalam parameter channelId telah ditangguhkan. |
forbidden (403) |
playlistForbidden |
Playlist yang diidentifikasi dengan parameter id permintaan tidak mendukung permintaan tersebut atau permintaan tidak diotorisasi dengan benar. |
notFound (404) |
channelNotFound |
Saluran yang ditentukan dalam parameter channelId tidak dapat ditemukan. |
notFound (404) |
playlistNotFound |
Playlist yang diidentifikasi dengan parameter id permintaan tidak dapat ditemukan. |
invalidValue (400) |
playlistOperationUnsupported |
API tidak mendukung kemampuan untuk mencantumkan playlist yang ditentukan. Misalnya, Anda tidak dapat mencantumkan playlist tonton nanti. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.