search wynik zawiera informacje o filmie na YouTube, kanale lub playliście, które pasują do parametrów wyszukiwania określonych w żądaniu do interfejsu API. Wynik wyszukiwania wskazuje na jednoznacznie identyfikowalny zasób, np. film, ale nie ma własnych trwałych danych.
Metody
Interfejs API obsługuje te metody wyszukiwania:
- list
- Zwraca kolekcję 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,channeliplaylist, ale możesz też skonfigurować zapytania tak, aby pobierały tylko określony typ zasobu. Wypróbuj teraz
Prezentacja zasobów
Poniższa struktura JSON przedstawia 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
W tabeli poniżej znajdziesz definicje właściwości, które pojawiają się w wynikach wyszukiwania:
| Właściwości | |
|---|---|
kind |
stringOkreśla typ zasobu interfejsu API. Wartość będzie wynosić youtube#searchResult. |
etag |
etagEtag tego zasobu. |
id |
objectObiekt id zawiera informacje, które można wykorzystać do jednoznacznego zidentyfikowania zasobu pasującego do żądania wyszukiwania. |
id.kind |
stringTyp zasobu interfejsu API. |
id.videoId |
stringJeś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 |
stringJeśli wartość właściwości id.type to youtube#channel, ta właściwość będzie obecna, a jej wartość będzie zawierać identyfikator, którego YouTube używa do jednoznacznego identyfikowania kanału pasującego do zapytania. |
id.playlistId |
stringJeś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 identyfikowania playlisty pasującej do zapytania. |
snippet |
objectObiekt snippet zawiera podstawowe informacje o wyniku wyszukiwania, takie jak tytuł lub opis. Jeśli na przykład wynikiem wyszukiwania jest film, tytułem będzie tytuł filmu, a opisem – opis filmu. |
snippet.publishedAt |
datetimeData i godzina utworzenia zasobu, który identyfikuje wynik wyszukiwania. Wartość jest podana w formacie ISO 8601. |
snippet.channelId |
stringWartość, której YouTube używa do jednoznacznego identyfikowania kanału, który opublikował zasób identyfikowany przez wynik wyszukiwania. |
snippet.title |
stringTytuł wyniku wyszukiwania. |
snippet.description |
stringOpis wyniku wyszukiwania. |
snippet.thumbnails |
objectMapa 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) |
objectPrawidłowe wartości klucza to:
Uwaga: miniatury w rozdzielczości 1080p+ ( |
snippet.thumbnails.(key).url |
stringAdres URL obrazu. |
snippet.thumbnails.(key).width |
unsigned integerSzerokość obrazu. |
snippet.thumbnails.(key).height |
unsigned integerWysokość obrazu. |
snippet.channelTitle |
stringTytuł kanału, który opublikował zasób zidentyfikowany w wyniku wyszukiwania. |
snippet.liveBroadcastContent |
stringWskazuje, 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. |