Search

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

Metody

Interfejs API obsługuje te metody wyszukiwania:

list
Zwraca zbiór wyników wyszukiwania, które pasują do parametrów zapytania określonych w żądaniu do interfejsu API. Domyślnie zbiór wyników wyszukiwania identyfikuje pasujące zasoby video, channel i playlist, ale możesz też skonfigurować zapytania tak, aby pobierać tylko zasoby określonego typu. Wypróbuj

Reprezentacja zasobu

Format wyniku wyszukiwania przedstawia poniższa struktura JSON:

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

Właściwości

W tej tabeli definiujemy właściwości, które pojawiają się w wynikach wyszukiwania:

Właściwości
kind string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#searchResult.
etag etag
Etag tego zasobu.
id object
Obiekt id zawiera informacje, które można wykorzystać do jednoznacznego zidentyfikowania 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, to ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego zidentyfikowania filmu pasującego do zapytania wyszukiwania.
id.channelId string
Jeśli wartość właściwości id.type to youtube#channel, to ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego zidentyfikowania kanału dopasowanego do zapytania wyszukiwania.
id.playlistId string
Jeśli wartość właściwości id.type to youtube#playlist, to ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego identyfikowania playlisty pasującej do zapytania wyszukiwania.
snippet object
Obiekt snippet zawiera podstawowe informacje o wyniku wyszukiwania, takie jak tytuł lub opis. Jeśli na przykład wynik wyszukiwania to film, tytuł będzie tytułem filmu, a opis – opisem filmu.
snippet.publishedAt datetime
Data i godzina utworzenia zasobu, który identyfikuje wynik wyszukiwania. Wartość jest określona w formacie ISO 8601.
snippet.channelId string
Wartość, której YouTube używa do jednoznacznego zidentyfikowania kanału, który opublikował zasób zidentyfikowany przez wynik wyszukiwania.
snippet.title string
Tytuł wyniku wyszukiwania.
snippet.description string
Opis wyniku wyszukiwania.
snippet.thumbnails object
Mapa obrazów miniatur powiązanych z wynikiem wyszukiwania. W przypadku każdego obiektu na mapie kluczem jest nazwa miniatury, a wartością jest obiekt zawierający inne informacje o miniaturze.
snippet.thumbnails.(key) object
Prawidłowe wartości klucza:
  • default – domyślna miniatura. Domyślna miniatura filmu lub zasobu odwołującego się do filmu (np. elementu playlisty lub wyniku wyszukiwania) ma szerokość 120 pikseli i wysokość 90 pikseli. Domyślna miniatura kanału ma 88 pikseli szerokości i 88 pikseli wysokości.
  • medium – wersja miniatury w wyższej rozdzielczości. W przypadku filmu (lub zasobu odwołującego się do filmu) obraz ma szerokość 320 pikseli i wysokość 180 pikseli. W przypadku kanału obraz ma 240 pikseli szerokości i 240 pikseli wysokości.
  • high – wersja miniatury w wysokiej rozdzielczości. W przypadku filmu (lub zasobu odwołującego się do filmu) obraz ma szerokość 480 pikseli i wysokość 360 pikseli. W przypadku kanału obraz ma 800 pikseli szerokości i 800 pikseli wysokości.
  • standard – wersja miniatury w jeszcze wyższej rozdzielczości niż obraz o rozdzielczości 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. Ten obraz ma 640 pikseli szerokości i 480 pikseli wysokości.
  • maxres – wersja miniatury w najwyższej rozdzielczości. Ten rozmiar obrazu 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. Ten obraz ma 1280 pikseli szerokości i 720 pikseli wysokości.
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 lub 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 transmisją na żywo, która jeszcze się nie rozpoczęła, a wartość live oznacza, że film jest aktywną transmisją na żywo. W przypadku zasobu channel wartość upcoming oznacza, że kanał ma zaplanowaną transmisję, która jeszcze się nie rozpoczęła, a wartość live oznacza, że kanał ma aktywną transmisję na żywo.