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
Этаг этого ресурса.
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 содержит основные сведения о результате поиска, такие как его заголовок или описание. Например, если результатом поиска является видео, то title будет названием видео, а описание — описанием видео.
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 пикселей и высоту 88 пикселей.
  • medium — версия миниатюры с более высоким разрешением. Для видео (или ресурса, ссылающегося на видео) это изображение имеет ширину 320 пикселей и высоту 180 пикселей. Для канала это изображение имеет ширину 240 пикселей и высоту 240 пикселей.
  • high — версия миниатюры с высоким разрешением. Для видео (или ресурса, ссылающегося на видео) это изображение имеет ширину 480 пикселей и высоту 360 пикселей. Для канала это изображение имеет ширину 800 пикселей и высоту 800 пикселей.
  • standard — версия миниатюры с еще более высоким разрешением, чем изображение high разрешением. Это изображение доступно для некоторых видео и других ресурсов, связанных с видео, например элементов плейлиста или результатов поиска. Это изображение имеет ширину 640 пикселей и высоту 480 пикселей.
  • maxres — версия миниатюры с самым высоким разрешением. Этот размер изображения доступен для некоторых видео и других ресурсов, связанных с видео, например элементов плейлиста или результатов поиска. Это изображение имеет ширину 1280 пикселей и высоту 720 пикселей.
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 указывает, что на канале есть активная прямая трансляция.