Sponsors: list

Observação: esse método foi descontinuado em 31 de março de 2020. Ele foi substituído pelo método members.list. Confira informações sobre esse método na documentação da API YouTube Data.

O método sponsors.list não será mais compatível a partir de 30 de setembro de 2020. Os clientes de API precisam atualizar as chamadas para o método sponsors.list para usar o método members.list.

Lista os membros (anteriormente conhecidos como "patrocinadores") de um canal. A solicitação de API precisa ser autorizada pelo proprietário do canal.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

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/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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 as partes dos recursos sponsor que serão incluídas pela resposta da API. Os valores aceitos são id e snippet.
Parâmetros opcionais
filter string
O parâmetro filter especifica quais patrocinadores do canal serão retornados. O valor padrão é newest.

Os valores aceitáveis são os seguintes:
  • all: retorna todos os patrocinadores, do mais recente ao mais antigo.
  • newest: retorna uma página dos patrocinadores mais recentes. As solicitações seguintes que usam o nextPageToken recuperam os assinantes mais recentes à medida que eles se inscrevem.
maxResults unsigned integer
O parâmetro maxResults especifica o número máximo de itens que precisam ser retornados no conjunto de resultados. Os valores aceitáveis são de 0 a 50, inclusive. O valor padrão é 5.
pageToken string
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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

Propriedades

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

Propriedades
kind string
Identifica o tipo de recurso da API. O valor será youtube#sponsorListResponse.
etag etag
A Etag desse recurso.
nextPageToken string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página do 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 dos patrocinadores que correspondem aos critérios da solicitação.

Erros

A tabela a seguir identifica mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
forbidden (403) insufficientPermissions Você não tem as permissões necessárias para acessar os patrocinadores do canal.
invalidValue (400) invalidValueInRequest A solicitação contém um valor inválido.
invalidValue (400) sponsorshipNotEnabledForChannelId O canal não está com os patrocínios ativados.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.