Um recurso playlistItem
identifica outro recurso, como um
vídeo, que é 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 nessa playlist.
O YouTube também usa uma playlist para identificar a lista de vídeos enviados de um canal, com cada
playlistItem
na lista representando um vídeo enviado. É possível extrair o
ID da playlist desse recurso do channel
para um determinado canal. Em seguida, use o método
playlistItems.list
na
lista.
Métodos
A API oferece suporte aos seguintes métodos para recursos playlistItems
:
- list
- Retorna uma coleção de itens de playlist que correspondem aos parâmetros de 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 de 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 exclusivamente o item da playlist. |
snippet |
object O objeto snippet contém detalhes básicos sobre o item da playlist, como título e posição. |
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 exclusivamente 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 de 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:
|
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 o vídeo. |
snippet.videoOwnerChannelId |
string O ID do canal que enviou o 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 baseado em zero, então 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 exclusivamente o recurso incluído na playlist como o item da playlist. |
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 na playlist. |
contentDetails |
object O objeto contentDetails é 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 um vídeo de forma exclusiva. Para recuperar o recurso video , defina o parâmetro de consulta id como esse valor na solicitação da API. |
contentDetails.startAt |
string Observação:essa propriedade foi descontinuada e, se definida, o valor dela será ignorado. O tempo, medido em segundos a partir do início do vídeo, em que o vídeo 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 a partir do início do vídeo, em que o vídeo 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, considere que video.endTime é o fim do vídeo. |
contentDetails.note |
string Uma nota gerada pelo usuário para este item. O valor da propriedade tem um comprimento máximo de 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 . |