PlaylistItems: update

Modifica um item da playlist. Por exemplo, você poderia atualizar a posição do item na playlist.

Impacto da 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/playlistItems

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

Esse método vai substituir os valores atuais de todas as propriedades mutáveis contidas em qualquer parte especificada pelo valor do parâmetro. Por exemplo, um item de playlist pode especificar uma tempo de início e de término que identificam a parte do vídeo que será reproduzida quando os usuários assistirem a ele na playlist. Se a solicitação estiver atualizando um item da playlist que define esses valores e o valor do parâmetro part da solicitação incluir a parte contentDetails, os horários de início e término do item da playlist serão atualizados para o valor especificado pelo corpo da solicitação. Se o corpo da solicitação não especificar valores, os horários de início e término atuais serão removidos e substituídos pelas configurações padrão.

A lista a seguir contém os nomes de part que podem ser incluídos no valor do parâmetro:
  • contentDetails
  • id
  • snippet
  • status
Parâmetros opcionais
onBehalfOfContentOwner string
Observação:o parâmetro onBehalfOfContentOwner é destinado exclusivamente a parceiros de conteúdo do YouTube e só pode ser usado em uma solicitação autorizada.

Esse parâmetro foi criado para parceiros de conteúdo do YouTube que possuem e gerenciam muitos canais diferentes do YouTube. Ele permite que usuários afiliados ao proprietário do conteúdo se autentiquem uma vez e possam acessar e gerenciar todos os dados do vídeo e do canal do proprietário do conteúdo, sem precisar fornecer credenciais de autenticação para cada canal individual.

Quando o parâmetro está presente, seu valor identifica um proprietário de conteúdo, e as credenciais de autorização da solicitação identificam um usuário do YouTube que está autorizado a agir em nome dele. A conta usada para a autenticação do usuário precisa estar vinculada ao proprietário do conteúdo especificado nas configurações do YouTube Creator Studio.

Corpo da solicitação

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

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

    • id
    • snippet.playlistId
    • snippet.resourceId

  • Você pode definir valores para estas propriedades:

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

    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 playlistItem 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
forbidden (403) playlistItemsNotAccessible A solicitação não está devidamente autorizada a atualizar o item da playlist especificado.
invalidValue (400) invalidPlaylistItemPosition A solicitação tenta definir a posição do item da playlist com um valor inválido ou não suportado. Verifique o valor da propriedade position no snippet do recurso.
invalidValue (400) invalidResourceType O type especificado para o ID do recurso não é suportado para esta operação. O ID do recurso identifica o item que está sendo adicionado à playlist, por exemplo, youtube#video.
invalidValue (400) invalidSnippet A solicitação não especifica uma propriedade snippet válida.
invalidValue (400) manualSortRequired A solicitação tenta definir a posição do item da playlist, mas a playlist não usa classificação manual. Por exemplo, os itens da playlist podem ser classificados por data ou popularidade. Para solucionar o erro, remova o elemento snippet.position do recurso que a solicitação está inserindo. Se quiser que o item da playlist tenha uma posição específica na lista, atualize a opção Ordem da playlist para Manual nas configurações da playlist. Essas configurações podem ser ajustadas no Gerenciador de vídeos do YouTube.
notFound (404) playlistItemNotFound O item da playlist identificado com a propriedade id da solicitação não foi encontrado.
notFound (404) playlistNotFound A playlist identificada com o parâmetro playlistId da solicitação não foi encontrada.
required (400) channelIdRequired A solicitação não especifica um valor para a propriedade channelId obrigatória.
required (400) playlistIdRequired A solicitação não especifica um valor para a propriedade playlistId obrigatória.
required (400) playlistItemIdRequired O recurso do item da playlist especificado na solicitação precisa usar a propriedade id para identificar o item da playlist que está sendo atualizado.
invalidValue (400) playlistOperationUnsupported A API não suporta a capacidade de atualizar vídeos na lista de reprodução especificada. Por exemplo, não é possível atualizar um vídeo na playlist de vídeos enviados.

Confira!

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