Search

Wynik wyszukiwania zawiera informacje o filmie, kanale lub playliście w YouTube, które odpowiadają parametrom wyszukiwania określonym w żądaniu do interfejsu API. Chociaż wynik wyszukiwania wskazuje zasób, który można jednoznacznie zidentyfikować, np. film, nie ma własnych danych trwałych.

Metody

Interfejs API obsługuje te metody wyszukiwania:

list
Zwraca zbiór wyników wyszukiwania pasujących do parametrów zapytania określonych w żądaniu do interfejsu API. Domyślnie zestaw wyników wyszukiwania zawiera zasoby pasujące do video, channel i playlist, ale możesz też skonfigurować zapytania tak, aby pobierały tylko określony typ zasobów. Wypróbuj teraz

Reprezentowanie zasobów

Poniższa struktura JSON pokazuje format wyniku wyszukiwania:

{
  "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
  }
}

Usługi

Poniższa tabela określa właściwości, które pojawiają się w wynikach wyszukiwania:

Usługi
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#searchResult.
etag etag
Otagowanie tego zasobu.
id object
Obiekt id zawiera informacje, które można wykorzystać do jednoznacznej identyfikacji zasobu pasującego do żądania wyszukiwania.
id.kind string
Typ zasobu interfejsu API.
id.videoId string
Jeśli wartość właściwości id.type to youtube#video, ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego identyfikowania filmu pasującego do zapytania.
id.channelId string
Jeśli wartość właściwości id.type to youtube#channel, ta właściwość będzie obecna i będzie zawierać identyfikator, którego YouTube używa do jednoznacznego identyfikowania kanału pasującego do zapytania.
id.playlistId string
Jeśli wartość właściwości id.type to youtube#playlist, ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego zidentyfikowania playlisty pasującej do zapytania.
snippet object
Obiekt snippet zawiera podstawowe informacje o wyniku wyszukiwania, np. tytuł lub opis. Jeśli na przykład wynikiem wyszukiwania jest film, tytułem będzie tytuł filmu, a opisem – jego opis.
snippet.publishedAt datetime
Data i godzina utworzenia zasobu zidentyfikowanego w wynikach wyszukiwania. Wartość ma format ISO 8601.
snippet.channelId string
Wartość, która jest używana przez YouTube do jednoznacznego identyfikowania kanału, w którym został zidentyfikowany zasób.
snippet.title string
Tytuł wyniku wyszukiwania.
snippet.description string
Opis wyniku wyszukiwania.
snippet.thumbnails object
Mapa miniaturek związanych z wynikiem wyszukiwania Kluczem jest nazwa obrazu miniatury, a wartość to obiekt zawierający inne informacje o miniaturze.
snippet.thumbnails.(key) object
Prawidłowe wartości to:
  • default – domyślny obraz miniatury. Domyślna miniatura filmu – lub zasób, który odnosi się do filmu – na przykład element playlisty lub wynik wyszukiwania – to 120 pikseli szerokości i 90 pikseli wysokości. Domyślna miniatura kanału ma 88 pikseli szerokości i 88 pikseli wysokości.
  • medium – wyższa wersja miniatury obrazu. W przypadku filmu (lub zasobu, który odnosi się do filmu), obraz ma szerokość 320 pikseli i wysokość 180 pikseli. W przypadku kanału obraz ma szerokość 240 pikseli i wysokość 240 pikseli.
  • high – wersja miniatury w wysokiej rozdzielczości. W przypadku filmu (lub zasobu, który odnosi się do filmu), obraz ma szerokość 480 i wysokość 360 pikseli. W przypadku kanału obraz ma szerokość 800 i wysokość 800 pikseli.
  • standard – jeszcze wyższa wersja miniatury obrazu niż high. Ten obraz jest dostępny w przypadku niektórych filmów i innych zasobów, które odnoszą się do filmów, takich jak elementy playlisty czy wyniki wyszukiwania. Obraz ma szerokość 640 i wysokość 480 pikseli.
  • maxres – wyższa wersja miniatury obrazu. Ten rozmiar jest dostępny w przypadku niektórych filmów i innych zasobów, które odnoszą się do filmów, takich jak elementy playlisty czy wyniki wyszukiwania. Obraz ma szerokość 1280 pikseli i wysokość 720 pikseli.
snippet.thumbnails.(key).url string
Adres URL obrazu.
snippet.thumbnails.(key).width unsigned integer
Szerokość obrazu.
snippet.thumbnails.(key).height unsigned integer
Wysokość obrazu.
snippet.channelTitle string
Tytuł kanału, który opublikował zasób zidentyfikowany przez wynik wyszukiwania.
snippet.liveBroadcastContent string
Wskazuje, czy zasób video czy channel zawiera treści transmitowane na żywo. Prawidłowe wartości właściwości to upcoming, live i none.

W przypadku zasobu video wartość upcoming oznacza, że film jest transmitowany na żywo, ale wartość live oznacza, że film jest aktywny. W przypadku zasobu channel wartość upcoming oznacza, że na kanale zaplanowano transmisję, która nie została jeszcze rozpoczęta, a wartość live oznacza, że kanał ma aktywną transmisję na żywo.