Captions: update

Обновляет дорожку субтитров. При обновлении дорожки субтитров можно изменить ее статус черновика, загрузить новый файл субтитров или сделать и то, и другое.

Этот метод поддерживает загрузку медиафайлов. Загружаемые файлы должны соответствовать следующим требованиям:

  • Максимальный размер файла: 100 МБ.
  • Поддерживаемые MIME-типы медиаконтента: text/xml, application/octet-stream, */*.

Влияние на квоту. Вызов этого метода расходует 450 единиц квоты.

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

Запрос

HTTP-запрос

PUT https://www.googleapis.com/upload/youtube/v3/captions

Авторизация

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

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

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part используется в этой операции в двух целях. Она определяет свойства, которые будут заданы операцией записи, а также свойства, которые будут включены в ответ API. Если вы обновляете статус черновика, задайте для свойства значение snippet. В противном случае задайте для свойства значение id.

В списке ниже приведены названия part, которые можно включить в значение параметра:
  • id
  • snippet
Необязательные параметры
onBehalfOfContentOwner string
Этот параметр можно использовать только в авторизованном запросе. Примечание. Этот параметр предназначен исключительно для партнеров YouTube по контенту.

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

Параметр sync указывает, нужно ли автоматически синхронизировать файл субтитров с аудиодорожкой видео. Если вы укажете значение true, YouTube автоматически синхронизирует дорожку субтитров с аудиодорожкой.

Тело запроса

В теле запроса укажите ресурс caption. Для этого ресурса:

  • Для следующих свойств необходимо указать значение:

    • id

  • Вы можете задать значения для следующих свойств:

    • snippet.isDraft

    Если вы отправляете запрос на обновление и в нем не указано значение для свойства, у которого оно уже есть, существующее значение будет удалено.

Ответ

Если запрос выполнен успешно, этот метод возвращает ресурс субтитров в теле ответа.

Ошибки

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

Тип ошибки Сведения об ошибке Описание
badRequest (400) contentRequired В запросе не был загружен обновленный файл субтитров. Если для параметра sync задано значение true, необходимо указать фактическое содержимое трека.
forbidden (403) forbidden Разрешений, связанных с запросом, недостаточно для обновления дорожки субтитров. Запрос может быть не авторизован.
notFound (404) captionNotFound Указанная дорожка субтитров не найдена. Проверьте значение свойства id в запросе.

Попробовать

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