Результат поиска содержит информацию о видео, канале или плейлисте 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 Допустимые значения ключей:
|
snippet.thumbnails.(key). url | string URL изображения. |
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 указывает, что на канале есть активная прямая трансляция. |