Загружает субтитры.
Этот метод поддерживает загрузку мультимедиа. Загруженные файлы должны соответствовать следующим ограничениям:
- Максимальный размер файла: 100 МБ.
- Допустимые типы MIME мультимедиа:
text/xml
,application/octet-stream
,*/*
Влияние квоты. Стоимость вызова этого метода составляет 400 единиц.
Распространенные случаи использования
Запрос
HTTP-запрос
POST https://www.googleapis.com/upload/youtube/v3/captions
Авторизация
Для этого запроса требуется авторизация хотя бы с одной из следующих областей. Дополнительные сведения об аутентификации и авторизации см. в разделе «Реализация авторизации OAuth 2.0» .
Объем |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
Параметры
В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
Параметры | ||
---|---|---|
Обязательные параметры | ||
part | string Параметр part указывает части ресурса caption , которые будут включены в ответ API. Установите значение параметра snippet .Следующий список содержит названия part , которые можно включить в значение параметра:
| |
Дополнительные параметры | ||
onBehalfOfContentOwner | string Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Фактическая учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
sync | boolean Этот параметр устарел. Параметр sync указывает, должен ли YouTube автоматически синхронизировать файл субтитров со звуковой дорожкой видео. Если вы установите значение true , YouTube будет игнорировать все тайм-коды, содержащиеся в загруженном файле подписей, и будет генерировать для подписей новые тайм-коды.Вам следует установить для параметра sync значение true если вы загружаете расшифровку, не имеющую тайм-кодов, или если вы подозреваете, что тайм-коды в вашем файле неверны, и хотите, чтобы YouTube попытался их исправить. |
Тело запроса
Укажите ресурс caption
в теле запроса. Для этого ресурса:
Вы должны указать значение для этих свойств:
-
snippet.videoId
-
snippet.language
-
snippet.name
Вы можете установить значения для этих свойств:
-
snippet.videoId
-
snippet.language
-
snippet.name
-
snippet.isDraft
Ответ
В случае успеха этот метод возвращает ресурс caption
в теле ответа.
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Дополнительные сведения см. в разделе API данных YouTube — ошибки .
Тип ошибки | Детализация ошибки | Описание |
---|---|---|
badRequest (400) | contentRequired | Запрос не содержит содержимого дорожки субтитров. |
conflict (409) | captionExists | В указанном видео уже есть субтитры с заданными snippet.language и snippet.name . Видео может иметь несколько дорожек на одном языке, но каждая дорожка должна иметь разное имя.Существует несколько способов устранения ошибки. Вы можете удалить существующую дорожку, а затем вставить новую или изменить имя новой дорожки перед ее вставкой. |
forbidden (403) | forbidden | Разрешений, связанных с запросом, недостаточно для загрузки дорожки субтитров. Возможно, запрос не авторизован должным образом. |
invalidValue (400) | invalidMetadata | Запрос содержит недопустимые значения метаданных, из-за которых создание трека невозможно. Убедитесь, что в запросе указаны допустимые значения для свойств snippet.language , snippet.name и snippet.videoId . Свойство snippet.isDraft также можно включить, но это не обязательно. |
notFound (404) | videoNotFound | Не удалось найти видео, определенное параметром videoId . |
invalidValue (400) | nameTooLong | Имя snippet.name указанное в запросе, слишком длинное. Максимальная поддерживаемая длина — 150 символов. |
Попробуйте!
Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.
Загружает субтитры.
Этот метод поддерживает загрузку мультимедиа. Загруженные файлы должны соответствовать следующим ограничениям:
- Максимальный размер файла: 100 МБ.
- Допустимые типы MIME мультимедиа:
text/xml
,application/octet-stream
,*/*
Влияние квоты: вызов этого метода имеет стоимость квоты в 400 единиц.
Распространенные случаи использования
Запрос
HTTP-запрос
POST https://www.googleapis.com/upload/youtube/v3/captions
Авторизация
Для этого запроса требуется авторизация хотя бы с одной из следующих областей. Дополнительные сведения об аутентификации и авторизации см. в разделе «Реализация авторизации OAuth 2.0» .
Объем |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
Параметры
В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
Параметры | ||
---|---|---|
Обязательные параметры | ||
part | string Параметр part указывает части ресурса caption , которые будут включены в ответ API. Установите значение параметра snippet .Следующий список содержит названия part , которые можно включить в значение параметра:
| |
Дополнительные параметры | ||
onBehalfOfContentOwner | string Этот параметр можно использовать только в должным образом авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube CMS, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube. Это позволяет владельцам контента один раз пройти аутентификацию и получить доступ ко всем своим видео и данным каналов без необходимости предоставлять учетные данные аутентификации для каждого отдельного канала. Фактическая учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
sync | boolean Этот параметр устарел. Параметр sync указывает, должен ли YouTube автоматически синхронизировать файл субтитров со звуковой дорожкой видео. Если вы установите значение true , YouTube будет игнорировать все тайм-коды, содержащиеся в загруженном файле подписей, и будет генерировать для подписей новые тайм-коды.Вам следует установить для параметра sync значение true если вы загружаете расшифровку, у которой нет тайм-кодов, или если вы подозреваете, что тайм-коды в вашем файле неверны и хотите, чтобы YouTube попытался их исправить. |
Тело запроса
Укажите ресурс caption
в теле запроса. Для этого ресурса:
Вы должны указать значение для этих свойств:
-
snippet.videoId
-
snippet.language
-
snippet.name
Вы можете установить значения для этих свойств:
-
snippet.videoId
-
snippet.language
-
snippet.name
-
snippet.isDraft
Ответ
В случае успеха этот метод возвращает ресурс caption
в теле ответа.
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может вернуть в ответ на вызов этого метода. Дополнительные сведения см. в разделе API данных YouTube — ошибки .
Тип ошибки | Детализация ошибки | Описание |
---|---|---|
badRequest (400) | contentRequired | Запрос не содержит содержимого дорожки субтитров. |
conflict (409) | captionExists | В указанном видео уже есть субтитры с заданными snippet.language и snippet.name . Видео может иметь несколько дорожек на одном языке, но каждая дорожка должна иметь разное имя.Существует несколько способов устранения ошибки. Вы можете удалить существующую дорожку, а затем вставить новую или изменить имя новой дорожки перед ее вставкой. |
forbidden (403) | forbidden | Разрешений, связанных с запросом, недостаточно для загрузки дорожки субтитров. Возможно, запрос не авторизован должным образом. |
invalidValue (400) | invalidMetadata | Запрос содержит недопустимые значения метаданных, из-за которых создание трека невозможно. Убедитесь, что в запросе указаны допустимые значения для свойств snippet.language , snippet.name и snippet.videoId . Свойство snippet.isDraft также можно включить, но это не обязательно. |
notFound (404) | videoNotFound | Не удалось найти видео, определенное параметром videoId . |
invalidValue (400) | nameTooLong | Имя snippet.name указанное в запросе, слишком длинное. Максимальная поддерживаемая длина — 150 символов. |
Попробуйте!
Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.