Videos: list

Возвращает список видео, соответствующих параметрам запроса к API.

Влияние на квоту. Вызов этого метода расходует 1 единицу квоты.

Примеры использования

Запрос

HTTP-запрос

GET https://www.googleapis.com/youtube/v3/videos

Параметры

В таблице ниже перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.

Параметры
Обязательные параметры
part string
Параметр part задает список из одного или нескольких свойств ресурса video, разделенных запятыми, которые будут включены в ответ API.

Если параметр указывает на свойство, содержащее дочерние свойства, они также будут включены в ответ. Например, в ресурсе video свойство snippet содержит свойства channelId, title, description, tags и categoryId. Если вы зададите значение part=snippet, ответ API будет содержать все эти свойства.

Ниже перечислены названия part, которые можно включить в значение параметра.
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Фильтры (укажите ровно один из следующих параметров)
chart string
Параметр chart определяет диаграмму, которую вы хотите получить.

Допустимые значения:
id string
Параметр id содержит список идентификаторов видео YouTube, разделенных запятыми. В ресурсе video свойство id указывает идентификатор видео.
myRating string

Этот параметр можно использовать только в авторизованном запросе. Задайте для этого параметра значение like или dislike, чтобы API возвращал только видео, которым аутентифицированный пользователь поставил отметку "Нравится" или "Не нравится".



API возвращает не более 1000 видео. Даже если свойство pageInfo.totalResults в ответе указывает на большее общее количество, разбивка на страницы с помощью параметра pageToken позволяет получить только 1000 последних элементов.



Параметр принимает следующие значения:

  • dislike – возвращает только видео, которым авторизованный пользователь поставил дизлайк.
  • like – возвращает только видео, понравившиеся аутентифицированному пользователю.
Необязательные параметры
hl string
Параметр hl указывает API на необходимость получить локализованные метаданные ресурса для определенного языка приложения, поддерживаемого сайтом YouTube. Значение параметра должно быть кодом языка из списка, возвращаемого методом i18nLanguages.list.

Если сведения о локализованном ресурсе доступны на этом языке, объект snippet.localized ресурса будет содержать локализованные значения. Если локализованные данные недоступны, объект snippet.localized будет содержать сведения о ресурсе на языке по умолчанию.
maxHeight unsigned integer
Параметр maxHeight задает максимальную высоту встроенного проигрывателя, возвращаемую в свойстве player.embedHtml. С помощью этого параметра можно указать, что вместо размеров по умолчанию в коде встраивания должна использоваться высота, соответствующая макету приложения. Если также указан параметр maxWidth, то высота проигрывателя может быть меньше значения maxHeight, чтобы не превысить максимальную ширину. Допустимые значения: от 72 до 8192 включительно.
maxResults unsigned integer
Параметр maxResults определяет максимальное количество элементов, которые должны быть возвращены в наборе результатов.

Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating, но не поддерживается для использования в сочетании с параметром id. Допустимые значения: от 1 до 50 включительно. Значение по умолчанию: 5.
maxWidth unsigned integer
Параметр maxWidth определяет максимальную ширину встроенного проигрывателя, возвращаемого в свойстве player.embedHtml. Этот параметр позволяет указать, что вместо размеров по умолчанию в коде для встраивания должна использоваться ширина, подходящая для макета приложения.

Если также указан параметр maxHeight, проигрыватель может быть уже, чем maxWidth, чтобы не превышать максимальную высоту. Допустимые значения: от 72 до 8192 включительно.
onBehalfOfContentOwner string
Этот параметр можно использовать только в авторизованном запросе. Примечание. Этот параметр предназначен исключительно для партнеров YouTube по контенту.

Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя системы управления контентом YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для партнеров YouTube, которым принадлежит множество каналов. Владельцы контента могут пройти аутентификацию один раз и получить доступ к данным всех своих видео и каналов. Аккаунт CMS, с помощью которого пользователь проходит аутентификацию, должен быть связан с указанным владельцем контента YouTube.
pageToken string
Параметр pageToken позволяет выбрать определенную страницу из набора результатов. В ответе API свойства nextPageToken и prevPageToken определяют другие страницы, которые можно получить.

Примечание. Этот параметр можно использовать вместе с параметром myRating, но не с параметром id.
regionCode string
Параметр regionCode указывает API, что нужно выбрать рейтинг видео, доступный в указанном регионе. Этот параметр можно использовать только в сочетании с параметром chart. Значение параметра – это код страны в формате ISO 3166-1 alpha-2.
videoCategoryId string
Параметр videoCategoryId определяет категорию видео, для которой нужно получить рейтинг. Этот параметр можно использовать только вместе с параметром chart. По умолчанию диаграммы не ограничены определенной категорией. Значение по умолчанию: 0.

Тело запроса

При вызове этого метода не указывайте тело запроса.

Ответ

В случае успеха метод возвращает тело ответа со следующей структурой:

{
  "kind": "youtube#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video Resource
  ]
}

Свойства

В таблице ниже приведены свойства, которые используются в этом ресурсе.

Свойства
kind string
Тип ресурса API. Значение будет youtube#videoListResponse.
etag etag
Тег Etag этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken, чтобы получить следующую страницу результатов.
prevPageToken string
Токен, который можно использовать в качестве значения параметра pageToken, чтобы получить предыдущую страницу результатов.
pageInfo object
Объект pageInfo содержит информацию о постраничной организации набора результатов.
pageInfo.totalResults integer
Общее количество результатов в наборе.
pageInfo.resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список видео, соответствующих критериям запроса.

Ошибки

В таблице ниже перечислены сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Подробную информацию вы найдете в документации по сообщениям об ошибках.

Тип ошибки Сведения об ошибке Описание
badRequest (400) videoChartNotFound Запрошенный чарт видео не поддерживается или недоступен.
forbidden (403) forbidden Запрос не авторизован для доступа к видеофайлу или информации об обработке. Обратите внимание, что части fileDetails, processingDetails и suggestions доступны только владельцу видео.
forbidden (403) forbidden Запрос не может получить доступ к информации о рейтингах пользователей. Эта ошибка может возникнуть, если у запроса нет разрешения на использование параметра myRating.
notFound (404) videoNotFound Не удалось найти видео, которое вы пытаетесь получить. Проверьте значение параметра id в запросе.

Попробовать

Используйте APIs Explorer, чтобы вызвать этот API и посмотреть запрос к API и ответ.