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