PlaylistItems

O recurso playlistItem identifica outro recurso incluído em uma playlist, como um vídeo por exemplo. Além disso, o recurso playlistItem contém detalhes sobre o recurso incluído que dizem respeito especificamente à forma como esse recurso é usado nessa playlist.

O YouTube usa playlists para identificar conjuntos especiais de vídeos para um canal, tais como:

  • vídeos enviados
  • vídeos favoritos
  • vídeos avaliados positivamente (gostei)
  • histórico de visualização
  • assistir mais tarde
Para ser mais específico, essas listas estão associadas a um canal, que é um conjunto de vídeos de uma pessoa, grupo ou empresa, playlists e outras informações do YouTube.

Você pode recuperar o IDs da playlist para cada uma dessas listas do channel resource para determinado canal. Em seguida, você pode usar o método playlistItems.list para recuperar qualquer uma dessas listas. Você também pode adicionar ou remover itens dessas listas chamando os métodos playlistItems.insert e playlistItems.delete. Por exemplo, se um usuário marca um vídeo como um vídeo favorito, você deve inserir esse vídeo na playlist de vídeos favoritos para o canal desse usuário.

Métodos

A API suporta os seguintes métodos para recursos playlistItems:

list
Retorna um conjunto de itens da playlist que correspondem aos parâmetros da solicitação de API. Você pode recuperar todos os itens da playlist em uma playlist especificada ou recuperar um ou mais itens da playlist por seus IDs exclusivos. Faça um teste agora.
insert
Adiciona um recurso a uma playlist. Faça um teste agora.
update
Modifica um item da playlist. Por exemplo, você poderia atualizar a posição do item na playlist. Faça um teste agora.
delete
Exclui um item da playlist. Faça um teste agora.

Representação de recurso

A estrutura JSON abaixo mostra o formato de um recurso playlistItems:

{
  "kind": "youtube#playlistItem",
  "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,
    "playlistId": string,
    "position": unsigned integer,
    "resourceId": {
      "kind": string,
      "videoId": string,
    }
  },
  "contentDetails": {
    "videoId": string,
    "startAt": string,
    "endAt": string,
    "note": string
  },
  "status": {
    "privacyStatus": string
  }
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
kind string
O tipo do recurso da API. O valor será youtube#playlistItem.
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 o item da playlist, como seu título e sua posição na playlist.
snippet.publishedAt datetime
A data e a hora em que o item foi adicionado à playlist. O valor é especificado no formato ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelId string
O ID que o YouTube usa para identificar de forma exclusiva o usuário que adicionou o item à playlist.
snippet.title string
O título do item.
snippet.description string
A descrição do item.
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 em 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 resolução mais alta 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 de 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.
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 ao qual a playlist pertence.
snippet.playlistId string
O ID que o YouTube usa para identificar de forma exclusiva a playlist na qual o item está.
snippet.position unsigned integer
A ordem na qual o item aparece na playlist. O valor usa um índice com base em zero, de modo que o primeiro item tem uma posição {0/}, o segundo item tem uma posição {1/} e assim por diante.
snippet.resourceId object
O objeto id contém informações que podem ser usadas para identificar de forma exclusiva o recurso que foi incluído na playlist como item.
snippet.resourceId.kind string
O tipo do recurso a que se refere.
snippet.resourceId.videoId string
Se o valor da propriedade snippet.resourceId.kind for youtube#video, esta propriedade estará presente, e seu valor conterá o ID que o YouTube usa para identificar de forma exclusiva o vídeo na playlist.
contentDetails object
O objeto contentDetails estará incluído no recurso se o item incluído for um vídeo do YouTube. O objeto contém informações adicionais sobre o vídeo.
contentDetails.videoId string
O ID que o YouTube usa para identificar de forma exclusiva um vídeo. Para recuperar o recurso video, defina o parâmetro de consulta id com este valor em sua solicitação de API.
contentDetails.startAt string
O tempo medido em segundos desde o início do vídeo, quando ele começa a ser reproduzido. O proprietário da playlist pode especificar os momentos em que o vídeo deve começar e parar de ser reproduzido e quando o vídeo é reproduzido no contexto da playlist. O valor padrão é {0/}.
contentDetails.endAt string
O tempo medido em segundos desde o início do vídeo, quando sua reprodução é interrompida. O proprietário da playlist pode especificar os momentos em que o vídeo deve começar e parar de ser reproduzido e quando o vídeo é reproduzido no contexto da playlist. Por padrão, suponha que video.endTime é o final do vídeo.
contentDetails.note string
Uma observação gerada pelo usuário para esse item.
status object
O objeto status contém informações sobre o status de privacidade do item da playlist.
status.privacyStatus string
O status de privacidade do item da playlist. O canal que enviou o vídeo representado pelo item da playlist pode definir esse valor usando o método videos.insert ou videos.update.