Результат search содержит информацию о видео, канале или плейлисте на YouTube, которые соответствуют параметрам поиска, указанным в запросе к API. Результат поиска указывает на однозначно идентифицируемый ресурс, например видео, но не имеет собственных постоянных данных.
Методы
API поддерживает следующие методы поиска:
- list
- Возвращает набор результатов поиска, соответствующих параметрам запроса, указанным в запросе к API. По умолчанию в результатах поиска указываются соответствующие запросу ресурсы
video,channelиplaylist, но вы также можете настроить запросы на получение только определенного типа ресурса. Попробовать
Представление ресурса
Ниже показана структура 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
}
}Свойства
В таблице ниже описаны свойства, которые появляются в результатах поиска.
| Свойства | |
|---|---|
kind |
stringТип ресурса API. Значение будет youtube#searchResult. |
etag |
etagТег ETag этого ресурса. |
id |
objectОбъект id содержит информацию, которая позволяет однозначно идентифицировать ресурс, соответствующий поисковому запросу. |
id.kind |
stringТип ресурса API. |
id.videoId |
stringЕсли свойство id.type имеет значение youtube#video, то это свойство будет присутствовать и его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации видео, соответствующего поисковому запросу. |
id.channelId |
stringЕсли значение свойства id.type – youtube#channel, то это свойство будет присутствовать, а его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации канала, соответствующего поисковому запросу. |
id.playlistId |
stringЕсли свойство id.type имеет значение youtube#playlist, то это свойство будет присутствовать и его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации плейлиста, соответствующего поисковому запросу. |
snippet |
objectОбъект snippet содержит основные сведения о результате поиска, например его заголовок или описание. Например, если в результатах поиска есть видео, то в качестве заголовка и описания будет использоваться название и описание видео. |
snippet.publishedAt |
datetimeДата и время создания ресурса, который идентифицирует результат поиска. Значение указывается в формате ISO 8601. |
snippet.channelId |
stringЗначение, которое YouTube использует для уникальной идентификации канала, опубликовавшего ресурс, указанный в результатах поиска. |
snippet.title |
stringЗаголовок результата поиска. |
snippet.description |
stringОписание результата поиска. |
snippet.thumbnails |
objectКарта значков, связанных с результатом поиска. Для каждого объекта на карте ключ – это название значка, а значение – это объект, который содержит другую информацию о значке. |
snippet.thumbnails.(key) |
objectДопустимые значения ключей:
Примечание. Значки с разрешением 1080p+ ( |
snippet.thumbnails.(key).url |
stringURL изображения. |
snippet.thumbnails.(key).width |
unsigned integerШирина изображения. |
snippet.thumbnails.(key).height |
unsigned integerВысота изображения. |
snippet.channelTitle |
stringНазвание канала, на котором опубликован ресурс, указанный в результатах поиска. |
snippet.liveBroadcastContent |
stringУказывает, содержит ли ресурс video или channel контент прямой трансляции. Допустимые значения: upcoming, live и none.Для ресурса video значение upcoming указывает, что видео – это прямая трансляция, которая ещё не началась, а значение live – что видео является активной прямой трансляцией. Для ресурса channel значение upcoming указывает, что на канале есть запланированная трансляция, которая ещё не началась, а значение live – что на канале идет прямая трансляция. |