Implementação: playlists

Os exemplos a seguir mostram como usar a API YouTube Data (v3) para realizar funções relacionadas a playlists e itens de playlist.

Extrair as playlists do usuário atual

Chame o método playlists.list para recuperar as playlists do usuário autenticado. Na solicitação, defina o valor do parâmetro mine como true. Uma solicitação que usa o parâmetro mine precisa ser autorizada usando o OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

Extrair as playlists de um usuário

Este exemplo recupera as playlists criadas por um canal específico. O exemplo tem duas etapas:

Recuperar informações sobre uma playlist específica

Para recuperar informações sobre uma ou mais playlists específicas, chame o método playlists.list e defina o parâmetro id como uma lista separada por vírgulas de IDs de playlist do YouTube que identificam os recursos desejados. Um caso de uso comum para essa funcionalidade é uma solicitação para recuperar informações adicionais sobre um grupo de playlists retornadas em um conjunto de resultados de pesquisa. Por exemplo, você pode querer recuperar o número de itens em cada playlist.

A solicitação abaixo chama o método playlists.list para extrair o número de itens em duas playlists que correspondem ao termo de consulta "GoogleDevelopers". Essas informações estão na propriedade contentDetails.itemCount do recurso playlist. Portanto, a solicitação define o valor do parâmetro part como contentDetails. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

Adicionar uma playlist

Este exemplo chama o método playlists.insert para criar uma playlist particular no canal do usuário autenticado. Qualquer solicitação de API para esse método precisa ser autorizada usando o OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

O link para o APIs Explorer também define um parâmetro que especifica o corpo da solicitação da API. O corpo da solicitação contém um recurso playlist, que define informações como o título, a descrição e o status de privacidade da playlist. Neste exemplo, o corpo da solicitação é:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

O exemplo a seguir marca a nova playlist como um programa de podcast:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

Exemplos de código relacionados: Java, JavaScript, .NET, PHP, Python

Atualizar uma playlist

Neste exemplo, o status de privacidade de uma playlist é atualizado de private para public. O exemplo tem duas etapas:

  • Etapa 1: extrair o ID da playlist

    Chame o método playlists.list para recuperar as playlists no canal do usuário autenticado. O exemplo de solicitação acima para recuperar as playlists do usuário atual demonstra essa solicitação. O aplicativo que chama a API pode processar a resposta da API para mostrar uma lista de playlists, usando o ID de cada playlist como chave.

  • Etapa 2: atualizar uma playlist

    Chame o método playlists.update para modificar uma playlist específica. Esse método exige um token de autorização OAuth 2.0 válido.

    O corpo da solicitação precisa incluir a parte snippet do recurso playlist, porque a propriedade snippet.title é necessária ao chamar esse método. Além disso, se o recurso de playlist que está sendo atualizado especificar valores para as propriedades snippet.description ou snippet.tags, esses valores precisarão ser especificados novamente na solicitação de atualização ou serão excluídos.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

    Como no exemplo acima para adicionar uma playlist, o link para o APIs Explorer define um parâmetro que especifica o corpo da solicitação da API. O corpo da solicitação contém um recurso playlist, que define informações como o título, a descrição e o status de privacidade da playlist. O corpo da solicitação a seguir é usado neste exemplo:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    O exemplo a seguir marca a playlist como um programa de podcast:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

    Observação:se você estiver testando essa consulta no APIs Explorer, substitua um ID de playlist válido no corpo do recurso. Para conseguir um ID de playlist, recomendamos que você execute primeiro a solicitação mostrada acima para adicionar uma playlist. Extraia o ID da playlist da resposta da API e use esse valor para a playlist que você quer atualizar. O título e a descrição da playlist usados neste exemplo são os mesmos do outro.

Adicionar um item de playlist

Este exemplo adiciona um item a uma playlist. Essa solicitação precisa ser autorizada usando o OAuth 2.0. Este exemplo tem duas etapas:

  • Etapa 1: extrair o ID da playlist adequada

    Chame o método playlists.list para recuperar as playlists no canal do usuário autenticado. O exemplo de solicitação acima para recuperar as playlists do usuário atual demonstra essa solicitação. O aplicativo que chama a API pode processar a resposta da API para mostrar uma lista de playlists, usando o ID de cada playlist como chave.

  • Etapa 2: adicionar um vídeo à playlist

    Chame o método playlistItems.insert para adicionar um vídeo à playlist. Essa solicitação precisa ser autorizada usando o OAuth 2.0. O corpo da solicitação é um recurso playlistItem que especifica pelo menos os seguintes valores:

    • O snippet.playlistId identifica a playlist em que você está adicionando o vídeo. Esse é o ID da playlist que você recebeu na etapa 1.
    • O snippet.resourceId.kind contém o valor youtube#video.
    • O snippet.resourceId.videoId identifica o vídeo que você está adicionando à playlist. O valor da propriedade é um ID exclusivo de vídeo do YouTube.

    A solicitação de API abaixo adiciona um vídeo a uma playlist. O corpo da solicitação é:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    Para concluir a solicitação no APIs Explorer, você precisa definir valores para as propriedades snippet.playlistId e snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    Observação:a documentação do método playlistItems.insert identifica os outros valores de propriedade que podem ser definidos ao adicionar um item de playlist.

Adicionar uma imagem de playlist

É possível usar o método playlistImages.insert da API v3 para fazer upload de uma imagem de miniatura personalizada e defini-la para uma playlist. Na sua solicitação, o valor do parâmetro playlistId identifica a playlist para a qual a miniatura será usada.

Essa consulta não pode ser testada usando o APIs Explorer porque ele não oferece suporte para fazer upload de arquivos de mídia, o que é um requisito para esse método.

Atualizar um item de playlist

Neste exemplo, um item de playlist é atualizado para ser o primeiro item de uma playlist. Essa solicitação precisa ser autorizada usando o OAuth 2.0. Este exemplo tem três etapas:

  • Etapa 1: extrair o ID da playlist adequada

    Chame o método playlists.list para recuperar as playlists no canal do usuário autenticado. O exemplo de solicitação acima para recuperar as playlists do usuário atual demonstra essa solicitação. O aplicativo que chama a API pode processar a resposta da API para mostrar uma lista de playlists, usando o ID de cada playlist como chave.

  • Etapa 2: extrair os itens da playlist selecionada

    Chame o método playlistItems.list para recuperar a lista de vídeos na playlist selecionada. Defina o valor do parâmetro playlistId como o ID da playlist que você obteve na etapa 1.

    Cada recurso na resposta da API contém uma propriedade id, que identifica o ID do item da playlist que identifica esse item de forma exclusiva. Você vai usar esse valor para remover um item da lista na próxima etapa.

  • Etapa 3: atualizar o item de playlist selecionado

    Chame o método playlistItems.update para mudar a posição do vídeo na playlist. Defina o valor do parâmetro part como snippet. O corpo da solicitação precisa ser um recurso playlistItem que defina pelo menos os seguintes valores:

    • Defina a propriedade id como o ID do item da playlist recebido na etapa 2.
    • Defina a propriedade snippet.playlistId como o ID da playlist recebido na etapa 1.
    • Defina a propriedade snippet.resourceId.kind como youtube#video.
    • Defina a propriedade snippet.resourceId.videoId como o ID do vídeo que identifica exclusivamente o conteúdo incluído na playlist.
    • Defina a propriedade snippet.position como 0 ou em qualquer posição em que você quer que o item apareça (usando um índice baseado em 0).

    A solicitação de API abaixo atualiza um item de playlist para ser o primeiro item de uma playlist. O corpo da solicitação é:

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    Para concluir a solicitação no APIs Explorer, é necessário definir valores para as propriedades id, snippet.playlistId e snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

Atualizar uma imagem de playlist

Você pode usar o método playlistImages.update da API v3 para atualizar a imagem em miniatura de uma playlist. Na sua solicitação, o valor do parâmetro playlistId identifica a playlist para a qual a miniatura será usada.

Essa consulta não pode ser testada usando o APIs Explorer porque ele não oferece suporte para fazer upload de arquivos de mídia, o que é um requisito para esse método.

Remover um item de playlist

Neste exemplo, um vídeo é excluído de uma playlist. Essa solicitação precisa ser autorizada usando o OAuth 2.0. Este exemplo tem três etapas. As duas primeiras etapas são as mesmas do exemplo acima para atualizar um item de playlist.

Depois de concluir essas etapas, chame o método playlistItems.delete para remover um vídeo da playlist. Defina o parâmetro id da solicitação como o ID do item da playlist que você quer remover. Essa solicitação precisa ser autorizada usando o OAuth 2.0.

O ID do item da playlist usado para identificar um vídeo em uma playlist é diferente do ID do vídeo do YouTube que identifica o vídeo de forma exclusiva. O ID do item da playlist identifica o vídeo como um item em uma playlist específica.

Para concluir a solicitação no APIs Explorer, você precisa definir o valor da propriedade id.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

Remover uma imagem de playlist

Neste exemplo, uma imagem de playlist é excluída. O exemplo tem duas etapas:

  • Etapa 1: recuperar a playlist

    Chame o método playlists.list para recuperar as playlists no canal do usuário autenticado. O exemplo de solicitação acima para recuperar as playlists do usuário atual demonstra essa solicitação. O aplicativo que chama a API pode processar a resposta da API para mostrar uma lista de playlists, usando o ID de cada playlist como chave.

  • Etapa 2: extrair o ID da imagem da playlist

    Chame o método playlistImages.list para recuperar a imagem em miniatura de uma playlist. Use o ID da playlist que você quer mudar.

  • Etapa 3: excluir uma imagem de playlist

    Chame o método playlistImages.delete para excluir uma imagem de playlist específica. Na solicitação, o parâmetro id especifica o ID da imagem da playlist que está sendo excluída. Esse método exige um token de autorização OAuth 2.0 válido. Se você estiver testando essa consulta no API Explorer, substitua o valor do parâmetro id por um ID de playlist válido.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID

    Observação:se você estiver testando essa consulta no APIs Explorer, substitua o valor do parâmetro id por um ID de imagem de playlist válido.

Remover uma playlist

Este exemplo exclui uma playlist. O exemplo tem duas etapas:

  • Etapa 1: extrair o ID da playlist

    Chame o método playlists.list para recuperar as playlists no canal do usuário autenticado. O exemplo de solicitação acima para recuperar as playlists do usuário atual demonstra essa solicitação. O aplicativo que chama a API pode processar a resposta da API para mostrar uma lista de playlists, usando o ID de cada playlist como chave.

  • Etapa 2: excluir uma playlist

    Chame o método playlists.delete para excluir uma playlist específica. Na solicitação, o parâmetro id especifica o ID da playlist que está sendo excluída. Esse método exige um token de autorização OAuth 2.0 válido. Se você estiver testando essa consulta no API Explorer, substitua o valor do parâmetro id por um ID de playlist válido.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    Observação:se você estiver testando essa consulta no APIs Explorer, substitua o valor do parâmetro id por um ID de playlist válido. Para conseguir um ID de playlist, recomendamos que você execute primeiro a solicitação mostrada acima para adicionar uma playlist. Extraia o ID da playlist da resposta da API e use esse valor para a playlist que você quer excluir.