PlaylistImages: list

Retorna um conjunto de imagens de playlist que correspondem aos parâmetros de solicitação da API. Você pode recuperar a imagem da lista de reprodução de uma lista de reprodução especificada ou recuperar uma ou mais imagens da lista de reprodução pelos IDs exclusivos.

Impacto de cota:uma chamada para esse método tem o custo de cota de 1 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 um lista separada por vírgulas de um ou mais recursos playlistImage que a resposta da API vai incluir.

Se o parâmetro identifica uma propriedade que contém propriedades filhas, as propriedades filhas serão incluídas na resposta.
Filtros (especifique exatamente um dos parâmetros a seguir)
id string e
O parâmetro id especifica uma lista separada por vírgulas de um ou mais IDs exclusivos de imagens de playlist.
playlistId string e
O parâmetro playlistId especifica o ID exclusivo da playlist para a qual você deseja recuperar imagens de playlist. Embora esse seja um parâmetro opcional, todas as solicitações para recuperar imagens da playlist precisam especificar um valor para o parâmetro id ou playlistId.
Parâmetros opcionais
maxResults unsigned integer e
O parâmetro maxResults especifica o número máximo de imagens que precisam ser retornadas no conjunto de resultados. Os valores aceitáveis são de 0 a 50. O valor padrão é 5.
onBehalfOfContentOwner string e
Esse parâmetro só pode ser usado em uma solicitação autorizada adequadamente. Observação:este 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 e
Esse parâmetro só pode ser usado em uma solicitação autorizada adequadamente. Observação: este parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.

O Parâmetro onBehalfOfContentOwnerChannel especifica o ID do canal do YouTube para o qual um vídeo está sendo adicionados. Esse parâmetro é obrigatório quando uma solicitação especifica um valor para o parâmetro parâmetro onBehalfOfContentOwner e só pode ser usado em junto com esse parâmetro. Além disso, a solicitação deve ser autorizado a usar uma conta do CMS vinculada ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner. Por fim, o canal em que o valor do parâmetro onBehalfOfContentOwnerChannel especifica devem ser vinculados ao proprietário do conteúdo especificado pelo parâmetro onBehalfOfContentOwner.

Esse destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam muitos diferentes canais do YouTube. Ele permite que os proprietários de conteúdo se autentiquem uma vez e realizar ações em nome do canal especificado no parâmetro sem precisar fornecer credenciais de autenticação para cada canal separado.
pageToken string e
O parâmetro pageToken identifica uma página específica no conjunto de resultados que será retornado. 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 e
Identifica o tipo de recurso da API. O valor será youtube#playlistImageListResponse.
nextPageToken string e
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página do conjunto de resultados.
prevPageToken string e
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a página anterior do conjunto de resultados.
pageInfo object e
O objeto pageInfo encapsula informações de paginação para o conjunto de resultados.
pageInfo.totalResults integer e
O número total de resultados no conjunto de resultados.
pageInfo.resultsPerPage integer e
O número de resultados incluídos na resposta da API.
items[] list e
Uma lista de imagens da playlist que correspondem aos critérios de solicitação.