Videos: update

A API agora é compatível com a capacidade de marcar seu canal ou seus vídeos como "conteúdo para crianças". Além disso, os recursos channel e video também contêm uma propriedade que identifica o status "conteúdo para crianças" do canal ou do vídeo. Os Termos de Serviço e as políticas para desenvolvedores da API YouTube também foram atualizados em 10 de janeiro de 2020. Para mais informações, consulte os históricos de revisões do serviço da API YouTube Data e dos Termos de Serviço dos serviços da API YouTube.

Atualiza os metadados de um vídeocanal.

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

PUT https://www.googleapis.com/youtube/v3/videos

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/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

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. Ele identifica as propriedades definidas pela operação de gravação e as que a resposta da API incluirá.

Esse método substitui os valores existentes de todas as propriedades mutáveis contidas em todas as partes especificadas pelo valor do parâmetro. Por exemplo, a configuração de privacidade de um vídeo está contida na parte status. Como tal, se sua solicitação estiver atualizando um vídeo privado e o valor do parâmetro part da solicitação incluir a parte status, a configuração de privacidade do vídeo será atualizada para qualquer valor especificado pelo corpo da solicitação. Se o corpo da solicitação não especificar um valor, a configuração de privacidade existente será removida e o vídeo será revertido para a configuração de privacidade padrão.

Além disso, nem todas as partes contêm propriedades que podem ser definidas ao inserir ou atualizar um vídeo. Por exemplo, o objeto statistics encapsula estatísticas que o YouTube calcula para um vídeo e não contém valores que podem ser definidos ou modificados. Se o valor do parâmetro especificar um part que não contenha valores mutáveis, esse part ainda será incluído na resposta da API.

A lista a seguir contém os nomes de part que podem ser incluídos no valor do parâmetro:
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
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 atua 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

Fornecer um recurso de vídeo no corpo da solicitação. Para esse recurso:

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

    • id
    • snippet.title: essa propriedade só será obrigatória se a solicitação atualizar o snippet do recurso video.
    • snippet.categoryId: essa propriedade só será obrigatória se a solicitação atualizar o snippet do recurso video.

  • Você pode definir valores para estas propriedades:

    • snippet.categoryId
    • snippet.defaultLanguage
    • snippet.description
    • snippet.tags[]
    • snippet.title
    • status.embeddable
    • status.license
    • status.privacyStatus
    • status.publicStatsViewable
    • status.publishAt: se você definir um valor para essa propriedade, também será necessário definir a propriedade status.privacyStatus como private.
    • status.selfDeclaredMadeForKids
    • recordingDetails.locationDescription (descontinuado)
    • recordingDetails.location.latitude (descontinuado)
    • recordingDetails.location.longitude (descontinuado)
    • recordingDetails.recordingDate
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

    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, este método retorna um recurso de vídeo 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) defaultLanguageNotSet A solicitação da API está tentando adicionar detalhes localizados do vídeo sem especificar o idioma padrão dos detalhes do vídeo.
badRequest (400) invalidCategoryId A propriedade snippet.categoryId especifica um ID de categoria inválido. Use o método videoCategories.list para recuperar as categorias compatíveis.
badRequest (400) invalidDefaultBroadcastPrivacySetting A solicitação tenta definir uma configuração de privacidade inválida para a transmissão padrão.
badRequest (400) invalidDescription Os metadados da solicitação especificam uma descrição de vídeo inválida.
badRequest (400) invalidPublishAt Os metadados da solicitação especificam um horário de publicação programado inválido.
badRequest (400) invalidRecordingDetails O objeto recordingDetails nos metadados da solicitação especifica detalhes de gravação inválidos.
badRequest (400) invalidTags Os metadados da solicitação especificam palavras-chave de vídeo inválidas.
badRequest (400) invalidTitle Os metadados da solicitação especificam um título de vídeo inválido ou vazio.
badRequest (400) invalidVideoMetadata Os metadados da solicitação são inválidos.
forbidden (403) forbidden
forbidden (403) forbiddenEmbedSetting A solicitação tenta definir uma configuração de incorporação inválida para o vídeo. Alguns canais podem não ter permissão para oferecer players incorporados em transmissões ao vivo. Consulte a Central de Ajuda do YouTube para mais informações.
forbidden (403) forbiddenLicenseSetting A solicitação tenta definir uma licença inválida para o vídeo.
forbidden (403) forbiddenPrivacySetting A solicitação tenta definir uma configuração de privacidade inválida para o vídeo.
notFound (404) videoNotFound O vídeo que você está tentando atualizar não pode ser encontrado. Verifique se o valor do campo id no corpo da solicitação está correto.

Confira!

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