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