Captions: download

Faz o download de uma faixa de legenda. A faixa de legenda é 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 da cota:uma chamada para esse método tem um custo de cota de 200 unidades.

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 legenda que está sendo recuperada. O valor é um ID de faixa de legenda, conforme identificado pela propriedade id em um recurso caption.
Parâmetros opcionais
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. 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 legenda precisa ser retornada em um formato específico. Se o parâmetro não estiver incluído na solicitação, a faixa vai ser retornada no formato original.

Os valores compatíveis são:
  • sbv: subtítulo de subvisualizador
  • scc – Formato de legenda descritiva do roteirista
  • srt: subtítulo do SubRip
  • ttml: legenda em linguagem de marcação de texto com marcação de tempo
  • vtt – Legenda das faixas de texto de vídeos da Web
tlang string
O parâmetro tlang especifica que a resposta da API precisa retornar uma tradução da faixa de legenda especificada. O valor do parâmetro é um código de idioma de duas letras ISO 639-1 (link em inglês) que identifica o idioma da legenda. Ela é gerada usando uma 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 for bem-sucedido, esse método retornará 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 legenda. É possível que a solicitação não seja autorizada ou que o pedido do vídeo não tenha ativado as contribuições de terceiros para essa legenda.
invalidValue (400) couldNotConvert Não foi possível converter os dados da faixa de legenda para o idioma e/ou formato solicitado. Verifique se os valores tfmt e tlang solicitados são válidos e se o snippet.status da faixa de legenda solicitada não é failed.
notFound (404) captionNotFound Não foi possível encontrar a faixa de legenda. Verifique o valor do parâmetro id da solicitação para garantir que ele está correto.

Confira!

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