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
  }
}

Характеристики

В следующей таблице определены свойства, которые появляются в результатах поиска:

Характеристики
kindstring
Идентифицирует тип ресурса API. Значением будет youtube#searchResult .
etagetag
Этаг этого ресурса.
idobject
Объект id содержит информацию, которую можно использовать для уникальной идентификации ресурса, соответствующего поисковому запросу.
id. kindstring
Тип ресурса API.
id. videoIdstring
Если значение свойства id.typeyoutube#video , то это свойство будет присутствовать, а его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации видео, соответствующего поисковому запросу.
id. channelIdstring
Если значение свойства id.typeyoutube#channel , то это свойство будет присутствовать, а его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации канала, соответствующего поисковому запросу.
id. playlistIdstring
Если значение свойства id.typeyoutube#playlist , то это свойство будет присутствовать, а его значение будет содержать идентификатор, который YouTube использует для уникальной идентификации списка воспроизведения, соответствующего поисковому запросу.
snippetobject
Объект snippet содержит основные сведения о результате поиска, такие как его заголовок или описание. Например, если результатом поиска является видео, то title будет названием видео, а описание — описанием видео.
snippet. publishedAtdatetime
Дата и время создания ресурса, который идентифицируется в результате поиска. Значение указывается в формате ISO 8601 .
snippet. channelIdstring
Значение, которое YouTube использует для уникальной идентификации канала, опубликовавшего ресурс, который идентифицируется в результатах поиска.
snippet. titlestring
Название результата поиска.
snippet. descriptionstring
Описание результата поиска.
snippet. thumbnailsobject
Карта миниатюр изображений, связанных с результатом поиска. Для каждого объекта на карте ключом является имя миниатюры изображения, а значением — объект, содержащий другую информацию о миниатюре.
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). urlstring
URL-адрес изображения.
snippet.thumbnails.(key). widthunsigned integer
Ширина изображения.
snippet.thumbnails.(key). heightunsigned integer
Высота изображения.
snippet. channelTitlestring
Название канала, опубликовавшего ресурс, который идентифицируется в результатах поиска.
snippet. liveBroadcastContentstring
Индикация того, имеет ли ресурс video или channel контент прямой трансляции. Действительные значения свойств являются upcoming , live и none .

Для video значение upcoming указывает, что видео представляет собой прямую трансляцию, которая еще не началась, а значение live указывает, что видео является активной прямой трансляцией. Для ресурса channel значение upcoming указывает, что на канале есть запланированная трансляция, которая еще не началась, а значение live указывает, что на канале есть активная прямая трансляция.