Captions: download

Скачивает дорожку субтитров. Дорожка субтитров возвращается в исходном формате, если в запросе не указано значение параметра tfmt, и на исходном языке, если в запросе не указано значение параметра tlang.

Влияние на квоту. При вызове этого метода квота уменьшается на 200 единиц.

Для этого у пользователя должно быть разрешение на редактирование видео.

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

Запрос

HTTP-запрос

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

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей доступа. Подробнее…

Область действия
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Параметры

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

Параметры
Обязательные параметры
id string
Параметр id указывает на дорожку субтитров, которую нужно получить. Значение представляет собой идентификатор дорожки субтитров, который определяется свойством id в ресурсе caption.
Необязательные параметры
onBehalfOfContentOwner string
Этот параметр можно использовать только в авторизованном запросе. Примечание. Этот параметр предназначен исключительно для партнеров YouTube по контенту.

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

Поддерживаемые значения:
  • sbv – субтитры SubViewer
  • scc – формат Scenarist Closed Caption;
  • srt – субтитры SubRip.
  • ttml – субтитры в формате Timed Text Markup Language;
  • vtt – субтитры Web Video Text Tracks;
tlang string
Параметр tlang указывает, что в ответе API должен быть перевод указанной дорожки субтитров. Значение параметра – двухбуквенный код языка по стандарту ISO 639-1, который определяет язык субтитров. Перевод выполняется с помощью машинного перевода, например Google Переводчика.

Тело запроса

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

Ответ

Если запрос выполнен успешно, этот метод возвращает двоичный файл. Заголовок Content-Type для ответа – application/octet-stream.

Ошибки

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

Тип ошибки Сведения об ошибке Описание
forbidden (403) forbidden Разрешений, связанных с запросом, недостаточно для скачивания дорожки субтитров. Запрос может быть не авторизован.
invalidValue (400) couldNotConvert Не удалось преобразовать данные дорожки субтитров в запрошенный язык и/или формат. Убедитесь, что значения параметров tfmt и tlang действительны и что параметр snippet.status запрошенной дорожки субтитров не имеет значения failed.
notFound (404) captionNotFound Не удалось найти дорожку субтитров. Проверьте значение параметра id в запросе.

Попробовать

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