PlaylistImages: list

Retorna uma coleção de imagens de playlists que correspondem aos parâmetros da solicitação da API. É possível recuperar a imagem de uma playlist específica ou uma ou mais imagens de playlists pelos IDs exclusivos delas.

Impacto na cota:uma chamada para esse método tem um custo de cota de uma unidade.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/youtube/v3/playlistImages

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string

O parâmetro part especifica uma lista separada por vírgulas de uma ou mais propriedades de recursos playlistImage que a resposta da API vai incluir.

Se o parâmetro identificar uma propriedade que contém propriedades filhas, elas serão incluídas na resposta.
Filtros (especifique exatamente um dos seguintes parâmetros)
id string
O parâmetro id especifica uma lista separada por vírgulas de um ou mais IDs exclusivos de imagens de playlist.
playlistId string
O parâmetro playlistId especifica o ID exclusivo da playlist para a qual você quer recuperar imagens. Embora seja um parâmetro opcional, toda solicitação para recuperar imagens de playlists precisa especificar um valor para o parâmetro id ou playlistId.
Parâmetros opcionais
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de imagens que devem ser retornadas no conjunto de resultados. Os valores aceitos vão de 0 a 50. O valor padrão é 5.
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação autorizada. Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor do parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado.
onBehalfOfContentOwnerChannel string
Esse parâmetro só pode ser usado em uma solicitação autorizada. Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O parâmetro onBehalfOfContentOwnerChannel especifica o ID do canal do YouTube em que um vídeo está sendo adicionado. Esse parâmetro é obrigatório quando uma solicitação especifica um valor para o parâmetro onBehalfOfContentOwner e só pode ser usado com ele. Além disso, a solicitação precisa ser autorizada usando uma conta do CMS vinculada ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner. Por fim, o canal especificado pelo valor do parâmetro onBehalfOfContentOwnerChannel precisa estar vinculado ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner.

Esse parâmetro é destinado a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais diferentes. Ele permite que os proprietários de conteúdo façam a autenticação uma vez e realizem ações em nome do canal especificado no valor do parâmetro sem precisar fornecer credenciais de autenticação para cada canal separado.
pageToken string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. Em uma resposta da API, as propriedades nextPageToken e prevPageToken identificam outras páginas que podem ser recuperadas.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
          "kind": "youtube#playlistImageListResponse",
          "nextPageToken": string,
          "prevPageToken": string,
          "pageInfo": {
            "totalResults": integer,
            "resultsPerPage": integer
          },
          "items": [
            playlistImages Resource
          ]
        }

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#playlistImageListResponse.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados.
prevPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior no conjunto de resultados.
pageInfo object
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer
O número de resultados incluídos na resposta da API.
items[] list
Uma lista de imagens de playlist que correspondem aos critérios da solicitação.