Um recurso playlist
representa uma playlist do YouTube. Uma playlist é um conjunto de vídeos que podem ser visualizados em sequência e compartilhados com outros usuários. Por padrão, as playlists ficam visíveis publicamente a outros usuários, mas elas podem ser públicas ou privadas.
O YouTube também usa playlists para identificar coleções especiais de vídeos para um canal, como:
- vídeos enviados
- vídeos avaliados positivamente (gostei)
channel resource
de um determinado canal.Depois, use o método
playlistItems.list
para recuperar qualquer uma dessas listas. Também é possível adicionar ou remover itens dessas listas chamando os métodos playlistItems.insert
e playlistItems.delete
.
Métodos
A API oferece suporte aos seguintes métodos para recursos playlists
:
- list
- Retorna uma coleção de playlists que correspondem aos parâmetros de solicitação da API. Por exemplo, você pode recuperar todas as playlists que o usuário autenticado possui ou recuperar uma ou mais playlists por seus IDs únicos. Faça um teste agora.
- inserir
- Cria uma playlist. Faça um teste agora.
- update
- Modifica uma playlist. Por exemplo, você pode alterar o título, a descrição ou o status de privacidade de uma playlist. Faça um teste agora.
- excluir
- Exclui uma playlist. Faça um teste agora.
Representação de recurso
A estrutura JSON a seguir mostra o formato de um recurso playlists
:
{ "kind": "youtube#playlist", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "defaultLanguage": string, "localized": { "title": string, "description": string } }, "status": { "privacyStatus": string }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string }, "localizations": { (key): { "title": string, "description": string } } }
Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
Propriedades | |
---|---|
kind |
string Identifica o tipo de recurso da API. O valor será youtube#playlist . |
etag |
etag A Etag desse recurso. |
id |
string O ID que o YouTube usa para identificar de forma exclusiva a playlist. |
snippet |
object O objeto snippet contém detalhes básicos sobre a playlist, como título e descrição. |
snippet.publishedAt |
datetime A data e a hora em que a playlist foi criada. O valor é especificado no formato ISO 8601. |
snippet.channelId |
string O ID que o YouTube usa para identificar de forma exclusiva o canal que publicou a playlist. |
snippet.title |
string O título da playlist. |
snippet.description |
string A descrição da playlist. |
snippet.thumbnails |
object Um mapa de imagens em miniatura associadas à playlist. Para cada objeto no mapa, a chave é o nome da imagem em miniatura, e o valor é um objeto que contém outras informações sobre a miniatura. |
snippet.thumbnails.(key) |
object As chaves-valor válidas são:
|
snippet.thumbnails.(key).url |
string O URL da imagem. |
snippet.thumbnails.(key).width |
unsigned integer A largura da imagem. |
snippet.thumbnails.(key).height |
unsigned integer A altura da imagem. |
snippet.channelTitle |
string O título do canal a que o vídeo pertence. |
snippet.tags[] |
list Essa propriedade foi descontinuada. Tags de palavra-chave associadas à playlist. |
snippet.defaultLanguage |
string O idioma do texto nas propriedades snippet.title e snippet.description do recurso playlist . |
snippet.localized |
object O objeto snippet.localized contém um título e uma descrição localizados para a playlist ou o título no idioma padrão para os metadados dela.
localizations para adicionar, atualizar ou excluir títulos localizados. |
snippet.localized.title |
string O título da playlist localizada. |
snippet.localized.description |
string A descrição da playlist localizada. |
status |
object O objeto status contém informações de status da playlist. |
status.privacyStatus |
string O status de privacidade da playlist. Os valores válidos para essa propriedade são:
|
contentDetails |
object O objeto contentDetails contém informações sobre o conteúdo da playlist, incluindo o número de vídeos dela. |
contentDetails.itemCount |
unsigned integer O número de vídeos na playlist. |
player |
object O objeto player contém informações que você usaria para abrir a playlist em um player incorporado. |
player.embedHtml |
string Uma tag <iframe> que incorpora um player que reproduzirá a playlist. |
localizations |
object O objeto localizations encapsula as traduções dos metadados da playlist. |
localizations.(key) |
object O idioma do texto localizado associado à chave-valor. O valor é uma string que contém um código de idioma BCP-47. |
localizations.(key).title |
string O título da playlist localizada. |
localizations.(key).description |
string A descrição da playlist localizada. |