Captions: list

Возвращает список дорожек субтитров, связанных с указанным видео. Обратите внимание, что ответ API не содержит реальных титров и что метод captions.download предоставляет возможность получить дорожку титров.

Влияние квоты. Стоимость вызова этого метода составляет 50 единиц.

Распространенные случаи использования

Запрос

HTTP-запрос

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

Авторизация

Этот запрос требует авторизации хотя бы в одной из следующих областей ( подробнее об аутентификации и авторизации читайте здесь ).

Объем
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Параметры

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

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

В списке ниже содержатся названия part , которые можно включить в значение параметра:
  • id
  • snippet
videoId string
Параметр videoId указывает идентификатор видео YouTube, для которого API должен возвращать дорожки субтитров.
Дополнительные параметры
id string
Параметр id указывает список идентификаторов, разделенных запятыми, которые идентифицируют ресурсы caption , которые следует получить. Каждый идентификатор должен идентифицировать дорожку субтитров, связанную с указанным видео.
onBehalfOfContentOwner string
Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube.

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

Тело запроса

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

Ответ

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

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

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

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

Характеристики
kind string
Идентифицирует тип ресурса API. Значением будет youtube#captionListResponse .
etag etag
Etag этого ресурса.
items[] list
Список подписей, соответствующих критериям запроса.

Ошибки

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

Тип ошибки Детализация ошибки Описание
forbidden (403) forbidden Не удалось получить одну или несколько дорожек с субтитрами, поскольку разрешений, связанных с запросом, недостаточно для получения запрошенных ресурсов. Возможно, запрос не авторизован должным образом.
notFound (404) captionNotFound Не удалось найти одну или несколько указанных дорожек субтитров. Эта ошибка возникает, если параметр videoId идентифицирует фактическое видео, но параметр id идентифицирует либо несуществующие идентификаторы дорожек субтитров, либо идентификаторы дорожек, связанные с другими видео. Проверьте значения параметров id и videoId запроса, чтобы убедиться в их правильности.
notFound (404) videoNotFound Видео, определенное параметром videoId не найдено.

Попробуй это!

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.