Реализация: подписи

В следующих примерах показано, как использовать API данных YouTube (v3) для выполнения функций, связанных с субтитрами.

Получить список субтитров к видео

Чтобы получить список дорожек субтитров, доступных для определенного видео, вызовите метод captions.list . Задайте для параметра videoId значение идентификатора видео YouTube, который уникально идентифицирует видео, для которого вы получаете субтитры. Ваш запрос должен быть авторизован с использованием OAuth 2.0.

Приведенный ниже запрос получает список подписей к видео на канале Google Stories на YouTube:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?
part=snippet
&videoId=PRU2ShMzQRg

Примеры кода см. в документации метода captions.list .

Создать дорожку субтитров

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

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

  • snippet.videoId — идентифицирует видео, к которому добавляется дорожка субтитров.
  • snippet.language — язык субтитров.
  • snippet.name — название дорожки субтитров.

При загрузке субтитров доступны следующие дополнительные параметры:

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

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

  • Если вы установите для свойства snippet.isDraft ресурса caption значение true , дорожка не будет общедоступной.

Примеры кода см. в документации метода captions.insert .

Загрузите субтитры

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

Чтобы загрузить определенную дорожку субтитров, вызовите метод captions.download . Задайте в качестве значения параметра id идентификатор дорожки субтитров YouTube, который уникально идентифицирует загружаемую дорожку субтитров. Ваш запрос должен быть авторизован с использованием OAuth 2.0.

API v3 поддерживает следующие параметры:

  • Чтобы указать, что дорожка субтитров должна быть возвращена в определенном формате, установите значение параметра tfmt , чтобы определить желаемый формат. В определении параметра перечислены поддерживаемые значения.

  • Чтобы получить перевод дорожки субтитров, установите для параметра tlang двухбуквенный код языка ISO 639-1 , который идентифицирует желаемый язык субтитров. Перевод создается с помощью машинного перевода, например Google Translate.

Примеры кода см. в документации метода captions.download .

Обновить дорожку субтитров

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

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

Приведенный ниже запрос получает список подписей к видео на канале Google Stories на YouTube:

Запрос обновляет статус черновика дорожки субтитров на true , что означает, что дорожка не будет публично видна. Чтобы выполнить запрос в API Explorer, вам необходимо установить значение свойства id , чтобы идентифицировать дорожку субтитров.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet

Примеры кода см. в документации метода captions.update .

Удаление субтитров

В этом примере показано, как удалить дорожку субтитров. В примере есть следующие шаги:

  • Шаг 1. Получите идентификатор дорожки с субтитрами.

    Выполните описанные выше действия, чтобы получить список субтитров для видео. Список можно использовать для отображения списка дорожек с субтитрами, используя идентификатор каждой дорожки в качестве ключа.

  • Шаг 2. Удалите трек

    Вызовите метод captions.delete чтобы удалить определенное видео. В запросе параметр id указывает идентификатор субтитров удаляемой дорожки. Запрос должен быть авторизован с использованием OAuth 2.0. Если вы тестируете этот запрос в API Explorer, вам нужно будет заменить действительный идентификатор дорожки субтитров на значение параметра id .

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
id=CAPTION_TRACK_ID