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

Поддерживаемые значения:
  • sbv – субтитры SubViewer
  • scc – формат субтитров сценариста.
  • srt — субтитры SubRip
  • ttml — заголовок на языке разметки текста по времени.
  • vtt – заголовок текстовых дорожек веб-видео
tlang string
Параметр tlang указывает, что ответ API должен возвращать перевод указанной дорожки субтитров. Значение параметра представляет собой двухбуквенный код языка ISO 639-1, который определяет желаемый язык субтитров. Перевод создается с помощью машинного перевода, например Google Translate.

Тело запроса

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

Ответ

В случае успеха этот метод возвращает двоичный файл. Заголовок 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.