Wynik wyszukiwania zawiera informacje o filmie, kanale lub playliście w YouTube pasujące do parametrów wyszukiwania określonych w żądaniu do interfejsu API. Wynik wyszukiwania wskazuje unikalny zasób, taki jak film, ale nie ma własnych, trwałych danych.
Metody
Interfejs API obsługuje następujące 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 identyfikuje pasujące zasoby
video
,channel
iplaylist
, ale możesz skonfigurować zapytania pod kątem pobierania tylko określonego typu zasobów. Wypróbuj teraz
Reprezentacja zasobu
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 } }
Właściwości
Poniższa tabela przedstawia właściwości, które pojawiają się w wynikach wyszukiwania:
Właściwości | |
---|---|
kind |
string Określa typ zasobu interfejsu API. Wartością będzie youtube#searchResult . |
etag |
etag ETag tego zasobu. |
id |
object Obiekt id zawiera informacje, które pozwalają jednoznacznie zidentyfikować zasób pasujący do żądania wyszukiwania. |
id.kind |
string Typ zasobu 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 używany w YouTube do jednoznacznej identyfikacji filmu pasującego do wyszukiwanego hasła. |
id.channelId |
string Jeśli wartość właściwości id.type to youtube#channel , ta właściwość będzie dostępna, a jej wartość będzie zawierać identyfikator używany przez YouTube do jednoznacznej identyfikacji kanału pasującego do wyszukiwanego hasła. |
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 używany przez YouTube do jednoznacznego zidentyfikowania playlisty pasującej do zapytania. |
snippet |
object Obiekt snippet zawiera podstawowe informacje o wyniku wyszukiwania, takie jak jego tytuł lub opis. Jeśli na przykład wynik wyszukiwania to film, tytułem filmu będzie jego tytuł, a opis – opis. |
snippet.publishedAt |
datetime Data i godzina utworzenia zasobu zidentyfikowanego w wyniku wyszukiwania. Wartość należy podać w formacie ISO 8601. |
snippet.channelId |
string Wartość, na podstawie której YouTube jednoznacznie identyfikuje kanał, który opublikował zasób wymieniony w wynikach wyszukiwania. |
snippet.title |
string Tytuł wyniku wyszukiwania. |
snippet.description |
string Opis wyniku wyszukiwania. |
snippet.thumbnails |
object Mapa miniaturek obrazów powiązanych z wynikami wyszukiwania. W przypadku każdego obiektu na mapie kluczem jest nazwa obrazu miniatury, a wartością jest obiekt zawierający inne informacje na temat miniatury. |
snippet.thumbnails.(key) |
object Prawidłowe pary klucz-wartość to:
|
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 identyfikowany w wynikach wyszukiwania. |
snippet.liveBroadcastContent |
string Wskazuje, czy zasób video lub channel zawiera treści na żywo. Prawidłowe wartości właściwości to upcoming , live i none .W przypadku zasobu video wartość upcoming oznacza, że materiał wideo to transmisja 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 na kanale jest zaplanowana transmisja, która jeszcze się nie rozpoczęła, a wartość live oznacza, że na kanale jest aktywna transmisja na żywo. |