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 , которые можно включить в значение параметра:
  • 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 возвращал только видео, которые понравились или не понравились авторизованному пользователю.

Приемлемые значения:
  • 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 CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube.
pageToken string
Параметр pageToken идентифицирует конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken идентифицируют другие страницы, которые можно получить.

Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id .
regionCode string
Параметр regionCode указывает API выбрать видеодиаграмму, доступную в указанном регионе. Этот параметр можно использовать только вместе с параметром chart . Значением параметра является код страны ISO 3166-1 альфа-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
Этаг этого ресурса.
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.