Captions: list

Retorna uma lista de faixas de legenda associadas a um vídeo especificado. A resposta da API não contém as legendas reais, e o método captions.download permite recuperar uma faixa de legenda.

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

Casos de uso comuns

Solicitação

Solicitação HTTP

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

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 compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O parâmetro part especifica as partes do recurso caption que a resposta da API vai incluir.

A lista abaixo contém os nomes part que podem ser incluídos no valor de parâmetro:
  • id
  • snippet
videoId string
O parâmetro videoId especifica o ID do vídeo do YouTube para o qual a API precisa retornar faixas de legenda.
Parâmetros opcionais
id string
O parâmetro id especifica uma lista separada por vírgulas de IDs que identificam os recursos caption que precisam ser recuperados. Cada ID precisa identificar uma faixa de legenda associada ao vídeo especificado.
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.

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 corpo de resposta com esta estrutura:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#captionListResponse.
etag etag
O Etag desse recurso.
items[] list
Uma lista de legendas que correspondem aos critérios da solicitação.

Erros

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

Tipo de erro Detalhe do erro Descrição
forbidden (403) forbidden Não foi possível recuperar uma ou mais faixas de legenda porque as permissões associadas à solicitação não são suficientes para recuperar os recursos solicitados. A solicitação pode não es devidamente autorizada.
notFound (404) captionNotFound Não foi possível encontrar uma ou mais das faixas de legenda especificadas. Esse erro ocorre se o parâmetro videoId identificar um vídeo real, mas o parâmetro id identificar IDs de faixas de legenda que não existem ou IDs de faixas associados a outros vídeos. Verifique os valores dos parâmetros id e videoId da solicitação para garantir que eles estejam corretos.
notFound (404) videoNotFound Não foi possível encontrar o vídeo identificado pelo parâmetro videoId.

Confira!

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