Search

Hasil penelusuran 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 dikenali secara unik, seperti video, resource tersebut tidak memiliki data persisten sendiri.

Metode

API 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 menampilkan 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 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 saluran yang cocok dengan kueri penelusuran secara unik.
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 playlist secara unik yang cocok dengan kueri penelusuran.
snippet object
Objek 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 datetime
Tanggal dan waktu pembuatan resource yang diidentifikasi oleh hasil penelusuran. Nilai ditetapkan 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 di 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 resource yang merujuk pada video, seperti item playlist atau hasil penelusuran – memiliki lebar 120 piksel dan tinggi 90 piksel. Thumbnail default untuk channel adalah lebar 88 piksel dan tinggi 88 piksel.
  • medium – Versi gambar thumbnail yang beresolusi lebih tinggi. Untuk video (atau resource yang merujuk ke video), gambar ini memiliki lebar 320px dan tinggi 180px. Untuk channel, gambar ini memiliki lebar 240px dan tinggi 240px.
  • high – Versi thumbnail dengan resolusi tinggi. Untuk video (atau resource yang merujuk pada video), gambar ini memiliki lebar 480px dan tinggi 360px. Untuk channel, gambar ini memiliki lebar 800 piksel dan tinggi 800 piksel.
  • standard – Versi gambar thumbnail beresolusi lebih tinggi daripada gambar resolusi high. Gambar ini tersedia untuk beberapa video dan resource lain yang mengacu pada video, seperti item playlist atau hasil penelusuran. Gambar ini memiliki lebar 640 piksel dan tinggi 480 piksel.
  • maxres – Versi gambar thumbnail 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.
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 resource yang diidentifikasi oleh hasil penelusuran.
snippet.liveBroadcastContent string
Indikasi 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 live streaming yang belum dimulai, sedangkan nilai live menunjukkan bahwa video adalah live streaming aktif. Untuk resource channel, nilai upcoming menunjukkan bahwa saluran memiliki siaran terjadwal yang belum dimulai, sedangkan nilai live menunjukkan bahwa saluran memiliki siaran langsung yang aktif.