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 diidentifikasi secara unik, seperti video, hasil penelusuran tersebut tidak memiliki data persistennya sendiri.

Metode

API ini mendukung metode penelusuran berikut:

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 agar 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 akan berupa 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 video yang cocok dengan kueri penelusuran secara unik.
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 channel 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 penelusurannya adalah video, maka judulnya adalah judul video dan deskripsinya adalah deskripsi video.
snippet.publishedAt datetime
Tanggal dan waktu pembuatan resource yang diidentifikasi 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 referensi yang merujuk ke video, seperti item playlist atau hasil penelusuran – adalah lebar 120 piksel dan tinggi 90 piksel. Thumbnail default untuk saluran adalah lebar 88px dan tinggi 88px.
  • medium – Versi gambar thumbnail beresolusi lebih tinggi. Untuk video (atau sumber daya yang merujuk pada video), gambar ini memiliki lebar 320px dan tinggi 180px. Untuk channel, gambar ini memiliki lebar 240px dan tinggi 240px.
  • high – Versi gambar thumbnail beresolusi tinggi. Untuk video (atau sumber daya 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 beresolusi high. Gambar ini tersedia untuk beberapa video dan referensi lain yang merujuk ke video, seperti item playlist atau hasil penelusuran. Gambar ini memiliki lebar 640px dan tinggi 480px.
  • 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 1280px dan tinggi 720px.
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 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 tersebut adalah live streaming yang belum dimulai, sedangkan nilai live menunjukkan bahwa video tersebut adalah live streaming aktif. Untuk resource channel, nilai upcoming menunjukkan bahwa saluran memiliki siaran terjadwal yang belum dimulai, sedangkan nilai live menunjukkan bahwa saluran tersebut memiliki live streaming yang aktif.