Menampilkan daftar video 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/videos
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 video yang akan disertakan dalam respons API.Jika parameter mengidentifikasi properti yang berisi properti turunan, properti turunan akan disertakan dalam respons. Misalnya, di resource video , properti snippet berisi properti channelId , title , description , tags , dan categoryId . 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) | ||
chart |
string Parameter chart mengidentifikasi diagram yang ingin Anda ambil.Nilai yang dapat diterima adalah:
|
|
id |
string Parameter id menentukan daftar ID video YouTube yang dipisahkan koma untuk resource yang sedang diambil. Di resource video , properti id menentukan ID video. |
|
myRating |
string Parameter ini hanya dapat digunakan dalam permintaan yang diizinkan dengan benar. Tetapkan nilai parameter ini ke like atau dislike untuk menginstruksikan API agar hanya menampilkan video yang disukai atau tidak disukai oleh pengguna terautentikasi.Nilai yang dapat diterima adalah:
|
|
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. |
|
maxHeight |
unsigned integer Parameter maxHeight menentukan tinggi maksimum pemutar tersemat yang ditampilkan di properti player.embedHtml . Anda dapat menggunakan parameter ini untuk menentukan bahwa sebagai ganti dimensi default, kode sematan harus menggunakan tinggi yang sesuai untuk tata letak aplikasi Anda. Jika parameter maxWidth juga disediakan, pemutar mungkin lebih pendek dari maxHeight agar tidak melanggar lebar maksimum. Nilai yang dapat diterima adalah 72 hingga 8192 , inklusif. |
|
maxResults |
unsigned integer Parameter maxResults menentukan jumlah maksimum item yang harus ditampilkan dalam set hasil.Catatan: Parameter ini didukung untuk digunakan bersama dengan parameter myRating , tetapi tidak didukung untuk digunakan bersama dengan parameter id . Nilai yang dapat diterima adalah 1 hingga 50 , inklusif. Nilai defaultnya adalah 5 . |
|
maxWidth |
unsigned integer Parameter maxWidth menentukan lebar maksimum pemutar tersemat yang ditampilkan di properti player.embedHtml . Anda dapat menggunakan parameter ini untuk menentukan bahwa sebagai ganti dimensi default, kode sematan harus menggunakan lebar yang sesuai untuk tata letak aplikasi Anda.Jika parameter maxHeight juga disediakan, pemutar mungkin lebih sempit dari maxWidth agar tidak melanggar tinggi maksimum. Nilai yang dapat diterima adalah 72 hingga 8192 , inklusif. |
|
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. |
|
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.Catatan: Parameter ini didukung untuk digunakan bersama dengan parameter myRating , tetapi tidak didukung untuk digunakan bersama dengan parameter id . |
|
regionCode |
string Parameter regionCode menginstruksikan API untuk memilih diagram video yang tersedia di wilayah yang ditentukan. Parameter ini hanya dapat digunakan bersama dengan parameter chart . Nilai parameternya adalah kode negara ISO 3166-1 alpha-2. |
|
videoCategoryId |
string Parameter videoCategoryId mengidentifikasi kategori video yang diagramnya harus diambil. Parameter ini hanya dapat digunakan bersama dengan parameter chart . Secara default, diagram tidak dibatasi untuk kategori tertentu. Nilai defaultnya adalah 0 . |
Isi permintaan
Jangan berikan isi permintaan saat memanggil metode ini.
Tanggapan
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video Resource ] }
Properti
Tabel berikut menentukan properti yang muncul di resource ini:
Properti | |
---|---|
kind |
string Mengidentifikasi jenis resource API. Nilainya adalah youtube#videoListResponse . |
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 video 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) |
videoChartNotFound |
Diagram video yang diminta tidak didukung atau tidak tersedia. |
forbidden (403) |
forbidden |
Permintaan tidak diotorisasi dengan benar untuk mengakses file video atau informasi pemrosesan. Perhatikan bahwa bagian fileDetails , processingDetails , dan suggestions hanya tersedia untuk pemilik video tersebut. |
forbidden (403) |
forbidden |
Permintaan tidak dapat mengakses informasi rating pengguna. Error ini dapat terjadi karena permintaan tidak diberi otorisasi dengan benar untuk menggunakan parameter myRating . |
notFound (404) |
videoNotFound |
Video yang Anda coba ambil tidak dapat ditemukan. Periksa nilai parameter id permintaan untuk memastikan bahwa parameter tersebut sudah benar. |
Cobalah!
Gunakan APIs Explorer untuk memanggil API ini dan melihat permintaan dan respons API.