Результаты 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 | etagEtag этого ресурса. |
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 указывает на то, что у канала есть активная прямая трансляция. |