Обновляет субтитры. При обновлении дорожки субтитров вы можете изменить статус черновика дорожки, загрузить новый файл субтитров для дорожки или и то, и другое.
Этот метод поддерживает загрузку мультимедиа. Загруженные файлы должны соответствовать следующим ограничениям:
- Максимальный размер файла: 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 , которые можно включить в значение параметра:
| |
Дополнительные параметры | ||
onBehalfOfContentOwner | string Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Фактическая учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
sync | boolean Этот параметр устарел. Примечание. Сервер API обрабатывает значение параметра только в том случае, если запрос содержит обновленный файл подписи. Параметр sync указывает, должен ли YouTube автоматически синхронизировать файл субтитров со звуковой дорожкой видео. Если вы установите значение true , YouTube автоматически синхронизирует субтитры со звуковой дорожкой. |
Тело запроса
Укажите ресурс подписи в теле запроса. Для этого ресурса:
Вы должны указать значение для этих свойств:
-
id
-
Вы можете установить значения для этих свойств:
-
snippet.isDraft
Если вы отправляете запрос на обновление и в вашем запросе не указано значение свойства, которое уже имеет значение, существующее значение свойства будет удалено.
-
Ответ
В случае успеха этот метод возвращает ресурс подписи в теле ответа.
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .
Тип ошибки | Детализация ошибки | Описание |
---|---|---|
badRequest (400) | contentRequired | По запросу не был загружен обновленный файл субтитров. Фактическое содержимое дорожки требуется, если для параметра sync установлено значение true . |
forbidden (403) | forbidden | Разрешений, связанных с запросом, недостаточно для обновления дорожки субтитров. Возможно, запрос не авторизован должным образом. |
notFound (404) | captionNotFound | Указанная дорожка субтитров не найдена. Проверьте значение свойства id запроса, чтобы убедиться, что оно правильное. |
Попробуй это!
Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.
Обновляет субтитры. При обновлении дорожки субтитров вы можете изменить статус черновика дорожки, загрузить новый файл субтитров для дорожки или и то, и другое.
Этот метод поддерживает загрузку мультимедиа. Загруженные файлы должны соответствовать следующим ограничениям:
- Максимальный размер файла: 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 , которые можно включить в значение параметра:
| |
Дополнительные параметры | ||
onBehalfOfContentOwner | string Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Фактическая учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
sync | boolean Этот параметр устарел. Примечание. Сервер API обрабатывает значение параметра только в том случае, если запрос содержит обновленный файл подписи. Параметр sync указывает, должен ли YouTube автоматически синхронизировать файл субтитров со звуковой дорожкой видео. Если вы установите значение true , YouTube автоматически синхронизирует субтитры со звуковой дорожкой. |
Тело запроса
Укажите ресурс подписи в теле запроса. Для этого ресурса:
Вы должны указать значение для этих свойств:
-
id
-
Вы можете установить значения для этих свойств:
-
snippet.isDraft
Если вы отправляете запрос на обновление и в вашем запросе не указано значение свойства, которое уже имеет значение, существующее значение свойства будет удалено.
-
Ответ
В случае успеха этот метод возвращает ресурс подписи в теле ответа.
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .
Тип ошибки | Детализация ошибки | Описание |
---|---|---|
badRequest (400) | contentRequired | По запросу не был загружен обновленный файл субтитров. Фактическое содержимое дорожки требуется, если для параметра sync установлено значение true . |
forbidden (403) | forbidden | Разрешений, связанных с запросом, недостаточно для обновления дорожки субтитров. Возможно, запрос не авторизован должным образом. |
notFound (404) | captionNotFound | Указанная дорожка субтитров не найдена. Проверьте значение свойства id запроса, чтобы убедиться, что оно правильное. |
Попробуй это!
Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.