Playlists

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 de um canal, como:

  • vídeos enviados
  • vídeos avaliados positivamente (gostei)
Mais especificamente, essas listas são associadas a um canal, que é uma coleção de vídeos, playlists e outras informações do YouTube de uma pessoa, um grupo ou uma empresa. É possível recuperar os IDs de playlist de cada uma dessas listas no channel resource de um determinado canal.

Em seguida, 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 é compatível com os seguintes métodos para recursos playlists:

list
Retorna uma coleção de playlists que correspondem aos parâmetros da solicitação de 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.
delete
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,
    "podcastStatus": enum
  },
  "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 do recurso da API. O valor será youtube#playlist.
etag etag
A ETag deste recurso.
id string
O ID que o YouTube usa para identificar a playlist de forma exclusiva.
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
Os valores de chave válidos são:
  • default: a imagem de miniatura padrão. A miniatura padrão para um vídeo ou um recurso que se refere a um vídeo, como um item da playlist ou o resultado da pesquisa, tem 120 px de largura e 90px de altura. A miniatura padrão de um canal tem 88 px de largura e 88 px de altura.
  • medium: uma versão de maior resolução da imagem em miniatura. Para um vídeo (ou um recurso que se refira a um vídeo), esta imagem tem 320 px de largura e 180 px de altura. Para um canal, esta imagem tem 240 px de largura e 240 px de altura.
  • high: uma versão em alta resolução da imagem em miniatura. Para um vídeo (ou um recurso que se refira a um vídeo), esta imagem tem 480 px de largura e 360 px de altura. Para um canal, esta imagem tem 800 px de largura e 800 px de altura.
  • standard: uma versão de resolução ainda maior da imagem em miniatura do que a imagem de resolução high. Essa imagem está disponível para alguns vídeos e outros recursos que se referem a vídeos, como itens de playlist ou resultados da pesquisa. Esta imagem tem 640 px de largura e 480 px de altura.
  • maxres: a versão de maior resolução da imagem em miniatura. Esse tamanho de imagem está disponível para alguns vídeos e outros recursos que se referem a vídeos, como itens de playlist ou resultados da pesquisa. Esta imagem tem 1.280 px de largura e 720 px de altura.
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 palavras-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 dos metadados da playlist.
  • O texto localizado é retornado no snippet de recurso se a solicitação playlists.list usou o parâmetro hl para especificar um idioma em que o texto localizado deve ser retornado e se o texto localizado está disponível nesse idioma.
  • Os metadados do idioma padrão são retornados se um valor de parâmetro hl não for especificado ou se um valor for especificado, mas os metadados localizados não estiverem disponíveis para o idioma especificado.
A propriedade contém um valor somente leitura. Use o objeto localizations para adicionar, atualizar ou excluir títulos localizados.
snippet.localized.title string
O título localizado da playlist.
snippet.localized.description string
A descrição localizada da playlist.
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:
  • private
  • public
  • unlisted
status.podcastStatus string
O status de podcast da playlist. Se o valor for enabled, a playlist será marcada como um programa de podcast. Para definir o status de podcast de uma playlist como enabled, ela precisa ter uma imagem.

Os valores válidos para essa propriedade são:
  • enabled
  • disabled
  • unspecified
contentDetails object
O objeto contentDetails contém informações sobre o conteúdo da playlist, incluindo o número de vídeos nela.
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 tocar a playlist em um player incorporado.
player.embedHtml string
Uma tag <iframe> que incorpora um player para tocar a playlist.
localizations object
O objeto localizations encapsula traduções dos metadados da playlist.
localizations.(key) object
O idioma do texto localizado associado ao valor da chave. O valor é uma string que contém um código de idioma BCP-47.
localizations.(key).title string
O título localizado da playlist.
localizations.(key).description string
A descrição localizada da playlist.