Playlists: update

Modifica uma playlist. Por exemplo, você pode alterar o título, a descrição ou o status de privacidade de uma playlist.

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/playlists

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos. Para saber mais sobre autenticação e autorização, consulte Como implementar a autorização do OAuth 2.0.

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 que a operação de gravação vai definir, bem como as propriedades que a resposta da API vai incluir.

Esse método substitui os valores atuais de propriedades mutáveis contidas em qualquer parte especificada no corpo da solicitação. Por exemplo, a descrição de uma playlist está na parte snippet, que precisa ser incluída no corpo da solicitação. Se a solicitação não especificar um valor para a propriedade snippet.description, a descrição da playlist será excluída.

A lista a seguir contém os nomes part que podem ser incluídos no valor do parâmetro:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Parâmetros opcionais
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação autorizada adequada.

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 com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.

Corpo da solicitação

Forneça um recurso playlist no corpo da solicitação.

Para esse recurso:

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

    • id
    • snippet.title

  • Você pode definir valores para estas propriedades:

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • status.podcastStatus
    • snippet.defaultLanguage
    • 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, esse método retornará um recurso playlist no corpo da resposta.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Para mais detalhes, consulte API Data do YouTube: erros.

Tipo de erro Detalhe do erro Descrição
badRequest (400) defaultLanguageNotSetError O defaultLanguage precisa ser definido para atualizar localizations.
badRequest (400) localizationValidationError Um dos valores no objeto de localizações falhou na validação. Use o método playlists.list para extrair valores válidos e atualizá-los seguindo as diretrizes na documentação do recurso de playlists.
forbidden (403) playlistForbidden Essa operação é proibida ou a solicitação não está autorizada corretamente.
invalidValue (400) invalidPlaylistSnippet A solicitação fornece um snippet de playlist inválido.
notFound (404) playlistNotFound Não foi possível encontrar a playlist identificada com o parâmetro id da solicitação.
required (400) playlistTitleRequired A solicitação deve especificar um título da playlist.
invalidValue (400) playlistOperationUnsupported A API não oferece suporte para atualizar a playlist especificada. Por exemplo, não é possível atualizar as propriedades da playlist de vídeos enviados.

Confira!

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