Captions: insert

Carrega uma faixa de legenda.

Este método oferece suporte ao envio de mídia. Os arquivos enviados devem estar de acordo com estas restrições:

  • Tamanho máximo do arquivo: 100 MB
  • Tipos MIME de mídia aceitos: text/xml, application/octet-stream, */*

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

Casos de uso comuns

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/upload/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 dos recursos caption que serão incluídas pela resposta da API. Defina o valor do parâmetro como snippet.

A lista a seguir contém os nomes de part que você pode incluir no valor do parâmetro:
  • id
  • snippet
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.
sync boolean
Esse parâmetro foi descontinuado. O parâmetro sync indica se o YouTube deve sincronizar automaticamente o arquivo de legenda com a faixa de áudio do vídeo. Se você definir o valor como true, o YouTube vai ignorar os códigos de tempo que estão no arquivo de legenda enviado e gerar novos códigos de tempo para as legendas.

Defina o parâmetro sync como true se você estiver enviando uma transcrição, que não tem códigos de tempo, ou se suspeitar que os códigos de tempo no arquivo estão incorretos e quiser que o YouTube tente corrigi-los.

Corpo da solicitação

Forneça um recurso de legenda no corpo da solicitação. Para esse recurso:

  • É necessário especificar um valor para essas propriedades:

    • snippet.videoId
    • snippet.language
    • snippet.name

  • Você pode definir valores para estas propriedades:

    • snippet.videoId
    • snippet.language
    • snippet.name
    • snippet.isDraft

Resposta

Se for bem-sucedido, esse método retorna um recurso de legenda no corpo da resposta.

Erros

A tabela a seguir identifica 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
badRequest (400) contentRequired A solicitação não contém o conteúdo da faixa de legenda.
conflict (409) captionExists O vídeo especificado já tem uma faixa de legenda com os snippet.language e snippet.name fornecidos. Um vídeo pode ter várias faixas para o mesmo idioma, mas cada uma precisa ter um nome diferente.

Há várias maneiras de resolver o erro. Você pode excluir a faixa existente e inserir uma nova faixa ou alterar o nome da nova faixa antes de inseri-la.
forbidden (403) forbidden As permissões associadas à solicitação não são suficientes para fazer upload da faixa de legenda. A solicitação pode não es devidamente autorizada.
invalidValue (400) invalidMetadata A solicitação contém valores de metadados inválidos, que impedem a criação da faixa. Confirme se a solicitação especifica valores válidos para as propriedades snippet.language, snippet.name e snippet.videoId. A propriedade snippet.isDraft também pode ser incluída, mas não é obrigatória.
notFound (404) videoNotFound O vídeo identificado pelo parâmetro videoId não foi encontrado.
invalidValue (400) nameTooLong O snippet.name especificado na solicitação é muito longo. O tamanho máximo permitido é de 150 caracteres.

Confira!

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