Captions: download

Faz o download de uma faixa de legendas. A faixa de legendas é retornada no formato original, a menos que a solicitação especifique um valor para o parâmetro tfmt, e no idioma original, a menos que a solicitação especifique um valor para o parâmetro tlang.

Impacto na cota: uma chamada para esse método tem um custo de cota de 200 unidades.

Esse método exige que o usuário tenha permissão para editar o vídeo.

Casos de uso comuns

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/captions/id

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

Parâmetros

A tabela a seguir lista os parâmetros que esta consulta suporta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
id string
O parâmetro id identifica a faixa de legendas que está sendo recuperada. O valor é um ID de faixa de legendas identificado pela propriedade id em um recurso caption.
Parâmetros opcionais
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada. Observação: esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS real com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.
tfmt string
O parâmetro tfmt especifica que a faixa de legendas precisa ser retornada em um formato específico. Se o parâmetro não for incluído na solicitação, a faixa será retornada no formato original.

Os valores compatíveis são:
  • sbv – legenda do SubViewer
  • scc – formato de legenda descritiva do Scenarist
  • srt – legenda do SubRip
  • ttml – legenda de linguagem de marcação de texto temporizado
  • vtt – legenda de faixas de texto de vídeo da Web
tlang string
O parâmetro tlang especifica que a resposta da API precisa retornar uma tradução da faixa de legendas especificada. O valor do parâmetro é um código de idioma de duas letras ISO 639-1 que identifica o idioma de legenda desejado. A tradução é gerada usando a tradução automática, como o Google Tradutor.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se bem-sucedido, esse método retorna um arquivo binário. O cabeçalho Content-Type da resposta é application/octet-stream.

Erros

A tabela abaixo identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para este método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
forbidden (403) forbidden As permissões associadas à solicitação não são suficientes para fazer o download da faixa de legendas. A solicitação pode não es devidamente autorizada.
invalidValue (400) couldNotConvert Os dados da faixa de legendas não puderam ser convertidos para o idioma e/ou formato solicitados. Verifique se os valores tfmt e tlang solicitados são válidos e se o snippet.status da faixa de legendas solicitada não é failed.
notFound (404) captionNotFound Não foi possível encontrar a faixa de legendas. Verifique o valor do parâmetro id da solicitação para garantir que ele esteja correto.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.