PlaylistItems

Um recurso playlistItem identifica outro recurso, como um vídeo, que está incluído em uma playlist. Além disso, o recurso playlistItem contém detalhes sobre o recurso incluído que se referem especificamente a como ele é usado na playlist.

O YouTube também usa uma playlist para identificar a lista de vídeos enviados de um canal, com cada playlistItem nessa lista representando um vídeo enviado. É possível recuperar o ID da playlist dessa lista no recurso channel de um determinado canal. Em seguida, use o método playlistItems.list na lista.

Métodos

A API é compatível com os seguintes métodos para recursos playlistItems:

list
Retorna uma coleção de itens da playlist que correspondem aos parâmetros da solicitação da 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.
inserir
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 a seguir 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,
    "videoOwnerChannelTitle": string,
    "videoOwnerChannelId": string,
    "playlistId": string,
    "position": unsigned integer,
    "resourceId": {
      "kind": string,
      "videoId": string,
    }
  },
  "contentDetails": {
    "videoId": string,
    "startAt": string,
    "endAt": string,
    "note": string,
    "videoPublishedAt": datetime
  },
  "status": {
    "privacyStatus": 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#playlistItem.
etag etag
A ETag deste recurso.
id string
O ID que o YouTube usa para identificar o item da playlist de forma exclusiva.
snippet object
O objeto snippet contém detalhes básicos sobre o item da playlist, como título e 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.
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 ao item da 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 item da playlist pertence.
snippet.videoOwnerChannelTitle string
O título do canal que enviou este vídeo.
snippet.videoOwnerChannelId string
O ID do canal que enviou este vídeo.
snippet.playlistId string
O ID que o YouTube usa para identificar de forma exclusiva a playlist em que o item está.
snippet.position unsigned integer
A ordem em que o item aparece na playlist. O valor usa um índice com base em zero. Portanto, o primeiro item tem uma posição de 0, o segundo item tem uma posição de 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 incluído na playlist como o item dela.
snippet.resourceId.kind string
O tipo do recurso referenciado.
snippet.resourceId.videoId string
Se o valor da propriedade snippet.resourceId.kind for youtube#video, essa propriedade vai estar presente e o valor dela vai conter o ID que o YouTube usa para identificar o vídeo de forma exclusiva na playlist.
contentDetails object
O objeto contentDetails é incluído no recurso se o item 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 um vídeo de forma exclusiva. Para recuperar o recurso video, defina o parâmetro de consulta id como esse valor na sua solicitação de API.
contentDetails.startAt string
Observação:essa propriedade foi descontinuada e, se definida, o valor dela será ignorado.

O tempo, medido em segundos desde o início do vídeo, em que ele deve começar 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
Observação:essa propriedade foi descontinuada e, se definida, o valor dela será ignorado.

O tempo, medido em segundos desde o início do vídeo, em que ele deve parar de 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. Por padrão, suponha que o video.endTime seja o fim do vídeo.
contentDetails.note string
Uma observação gerada pelo usuário para este item. O valor da propriedade pode ter até 280 caracteres.
contentDetails.videoPublishedAt datetime
A data e a hora em que o vídeo foi publicado no YouTube. O valor é especificado no formato ISO 8601.
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.