Hasil search berisi informasi tentang video, channel, atau playlist YouTube yang cocok dengan parameter penelusuran yang ditentukan dalam permintaan API. Meskipun hasil penelusuran mengarah ke resource yang dapat diidentifikasi secara unik, seperti video, hasil penelusuran tidak memiliki data persistennya sendiri.
Metode
API ini mendukung metode berikut untuk penelusuran:
- list
- Menampilkan kumpulan hasil penelusuran yang cocok dengan parameter kueri yang ditentukan dalam permintaan API. Secara default, kumpulan hasil penelusuran mengidentifikasi resource
video,channel, danplaylistyang cocok, tetapi Anda juga dapat mengonfigurasi kueri untuk hanya mengambil jenis resource tertentu. Coba sekarang.
Representasi resource
Struktur JSON berikut menunjukkan format hasil penelusuran:
{
"kind": "youtube#searchResult",
"etag": etag,
"id": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
},
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"liveBroadcastContent": string
}
}Properti
Tabel berikut menentukan properti yang muncul di hasil penelusuran:
| Properti | |
|---|---|
kind |
stringMengidentifikasi jenis resource API. Nilainya akan menjadi youtube#searchResult. |
etag |
etagEtag resource ini. |
id |
objectObjek id berisi informasi yang dapat digunakan untuk mengidentifikasi resource yang cocok dengan permintaan penelusuran secara unik. |
id.kind |
stringJenis resource API. |
id.videoId |
stringJika nilai properti id.type adalah youtube#video, properti ini akan ada dan nilainya akan berisi ID yang digunakan YouTube untuk mengidentifikasi video yang cocok dengan kueri penelusuran secara unik. |
id.channelId |
stringJika nilai properti id.type adalah youtube#channel, properti ini akan ada dan nilainya akan berisi ID yang digunakan YouTube untuk mengidentifikasi channel yang cocok dengan kueri penelusuran secara unik. |
id.playlistId |
stringJika nilai properti id.type adalah youtube#playlist, properti ini akan ada dan nilainya akan berisi ID yang digunakan YouTube untuk mengidentifikasi playlist yang cocok dengan kueri penelusuran secara unik. |
snippet |
objectObjek snippet berisi detail dasar tentang hasil penelusuran, seperti judul atau deskripsinya. Misalnya, jika hasil penelusuran adalah video, judulnya akan menjadi judul video dan deskripsinya akan menjadi deskripsi video. |
snippet.publishedAt |
datetimeTanggal dan waktu pembuatan resource yang diidentifikasi oleh hasil penelusuran. Nilai ditentukan dalam format ISO 8601. |
snippet.channelId |
stringNilai yang digunakan YouTube untuk mengidentifikasi secara unik channel yang memublikasikan resource yang diidentifikasi hasil penelusuran. |
snippet.title |
stringJudul hasil penelusuran. |
snippet.description |
stringDeskripsi hasil penelusuran. |
snippet.thumbnails |
objectPeta gambar thumbnail yang terkait dengan hasil penelusuran. Untuk setiap objek di peta, kuncinya adalah nama gambar thumbnail, dan nilainya adalah objek yang berisi informasi lain tentang thumbnail. |
snippet.thumbnails.(key) |
objectNilai kunci yang valid adalah:
|
snippet.thumbnails.(key).url |
stringURL gambar. |
snippet.thumbnails.(key).width |
unsigned integerLebar gambar. |
snippet.thumbnails.(key).height |
unsigned integerTinggi gambar. |
snippet.channelTitle |
stringJudul channel yang memublikasikan resource yang diidentifikasi hasil penelusuran. |
snippet.liveBroadcastContent |
stringIndikasi apakah resource video atau channel memiliki konten siaran live. Nilai properti yang valid adalah upcoming, live, dan none.Untuk resource video, nilai upcoming menunjukkan bahwa video adalah siaran live yang belum dimulai, sedangkan nilai live menunjukkan bahwa video adalah siaran live yang aktif. Untuk resource channel, nilai upcoming menunjukkan bahwa saluran memiliki siaran terjadwal yang belum dimulai, sedangkan nilai live menunjukkan bahwa saluran memiliki siaran live yang aktif. |