Search

Hasil search berisi informasi tentang video YouTube, channel, atau playlist 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, dan playlist yang 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 dalam hasil penelusuran:

Properti
kind string
Mengidentifikasi jenis resource API. Nilainya adalah youtube#searchResult.
etag etag
ETag resource ini.
id object
Objek id berisi informasi yang dapat digunakan untuk mengidentifikasi resource secara unik yang cocok dengan permintaan penelusuran.
id.kind string
Jenis resource API.
id.videoId string
Jika nilai properti id.type adalah youtube#video, properti ini akan ada dan nilainya akan berisi ID yang digunakan YouTube untuk mengidentifikasi secara unik video yang cocok dengan kueri penelusuran.
id.channelId string
Jika nilai properti id.type adalah youtube#channel, properti ini akan ada dan nilainya akan berisi ID yang digunakan YouTube untuk mengidentifikasi secara unik channel yang cocok dengan kueri penelusuran.
id.playlistId string
Jika nilai properti id.type adalah youtube#playlist, properti ini akan ada dan nilainya akan berisi ID yang digunakan YouTube untuk mengidentifikasi daftar putar yang cocok dengan kueri penelusuran secara unik.
snippet object
Objek snippet berisi detail dasar tentang hasil penelusuran, seperti judul atau deskripsinya. Misalnya, jika hasil penelusuran adalah video, maka judulnya adalah judul video dan deskripsinya adalah deskripsi video.
snippet.publishedAt datetime
Tanggal dan waktu pembuatan resource yang diidentifikasi oleh hasil penelusuran. Nilai ditentukan dalam format ISO 8601.
snippet.channelId string
Nilai yang digunakan YouTube untuk mengidentifikasi secara unik channel yang memublikasikan resource yang diidentifikasi oleh hasil penelusuran.
snippet.title string
Judul hasil penelusuran.
snippet.description string
Deskripsi hasil penelusuran.
snippet.thumbnails object
Peta gambar thumbnail yang terkait dengan hasil penelusuran. Untuk setiap objek dalam peta, kuncinya adalah nama gambar thumbnail, dan nilainya adalah objek yang berisi informasi lain tentang thumbnail.
snippet.thumbnails.(key) object
Nilai kunci yang valid adalah:
  • default – Gambar thumbnail default. Thumbnail default untuk video – atau konten yang merujuk ke video, seperti item playlist atau hasil penelusuran – memiliki lebar 120 piksel dan tinggi 90 piksel. Thumbnail default untuk channel memiliki lebar 88 px dan tinggi 88 px.
  • medium – Versi gambar thumbnail dengan resolusi lebih tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 320 px dan tinggi 180 px. Untuk channel, gambar ini berukuran lebar 240 piksel dan tinggi 240 piksel.
  • high – Versi gambar thumbnail beresolusi tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 480 px dan tinggi 360 px. Untuk channel, gambar ini memiliki lebar 800 piksel dan tinggi 800 piksel.
  • standard – Versi gambar thumbnail dengan resolusi yang lebih tinggi daripada gambar resolusi high. Gambar ini tersedia untuk beberapa video dan konten lain yang merujuk ke video, seperti item playlist atau hasil penelusuran. Gambar ini memiliki lebar 640 piksel dan tinggi 480 piksel.
  • maxres – Versi gambar thumbnail dengan resolusi tertinggi. Ukuran gambar ini tersedia untuk beberapa video dan resource lain yang merujuk ke video, seperti item playlist atau hasil penelusuran. Gambar ini memiliki lebar 1280 piksel dan tinggi 720 piksel.

Catatan: Gambar mini 1080p+ (fhd, qhd, dan uhd) tidak didukung untuk hasil penelusuran. Untuk mengambil thumbnail resolusi yang lebih tinggi, panggil endpoint khusus resource (seperti videos.list) menggunakan ID resource.
snippet.thumbnails.(key).url string
URL gambar.
snippet.thumbnails.(key).width unsigned integer
Lebar gambar.
snippet.thumbnails.(key).height unsigned integer
Tinggi gambar.
snippet.channelTitle string
Judul channel yang memublikasikan aset yang diidentifikasi oleh hasil penelusuran.
snippet.liveBroadcastContent string
Indikasi apakah resource video atau channel memiliki konten live streaming. 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 channel memiliki siaran terjadwal yang belum dimulai, sedangkan nilai live menunjukkan bahwa channel memiliki siaran live yang aktif.