Search

Результат 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
Допустимые значения ключей:
  • default – уменьшенное изображение по умолчанию. Значок по умолчанию для видео или ресурса, который ссылается на видео (например, для элемента плейлиста или результата поиска), имеет ширину 120 пикселей и высоту 90 пикселей. По умолчанию значок канала имеет размер 88 x 88 пикселей.
  • medium – значок в более высоком разрешении. Для видео (или ресурса, который ссылается на видео) ширина изображения составляет 320 пикселей, а высота – 180 пикселей. Для канала это изображение размером 240 x 240 пикселей.
  • high – значок в высоком разрешении. Для видео (или ресурса, который ссылается на видео) это изображение имеет ширину 480 пикселей и высоту 360 пикселей. Для канала это изображение размером 800 x 800 пикселей.
  • standard – значок с разрешением, которое выше, чем у значка high. Это изображение доступно для некоторых видео и других ресурсов, которые ссылаются на видео, например элементов плейлиста или результатов поиска. Ширина этого изображения – 640 пкс, а высота – 480 пкс.
  • maxres – версия значка с самым высоким разрешением. Такой размер доступен для некоторых видео и других ресурсов, связанных с видео, например элементов плейлистов или результатов поиска. Ширина изображения – 1280 пикселей, высота – 720 пикселей.

Примечание. Значки с разрешением 1080p+ (fhd, qhd и uhd) не поддерживаются в результатах поиска. Чтобы получить значки с более высоким разрешением, вызовите конечную точку, относящуюся к определенному ресурсу (например, videos.list), используя идентификатор ресурса.

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 – что на канале идет прямая трансляция.