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 указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров 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.