Captions: update

Atualiza uma faixa de legenda. Ao atualizar uma faixa de legenda, é possível mudar o status do rascunho, fazer upload de um novo arquivo de legenda ou ambos.

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 450 unidades.

Casos de uso comuns

Solicitação

Solicitação HTTP

PUT 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 tem duas finalidades nesta operação. identifica as propriedades que serão definidas pela operação de gravação e as propriedades que serão incluídas pela resposta da API. Defina o valor da propriedade como snippet se você estiver atualizando o status de rascunho da faixa. Caso contrário, defina o valor da propriedade como id.

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. Observação:o servidor da API só vai processar o valor do parâmetro se a solicitação tiver um arquivo de legenda atualizado.

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 sincronizará automaticamente a faixa de legenda com a faixa de áudio.

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:

    • id

  • Você pode definir valores para estas propriedades:

    • snippet.isDraft

    Se você estiver enviando uma solicitação de atualização e ela não especificar um valor para uma propriedade que já tenha um, o valor existente da propriedade será excluído.

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 enviou um arquivo de legenda atualizado. O conteúdo real da faixa será necessário se o parâmetro sync estiver definido como true.
forbidden (403) forbidden As permissões associadas à solicitação não são suficientes para atualizar a faixa de legenda. A solicitação pode não es devidamente autorizada.
notFound (404) captionNotFound Não foi possível encontrar a faixa de legenda especificada. Verifique o valor da propriedade 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.