FanFundingEvents: list

Observação:este é um anúncio de descontinuação.

O recurso de financiamento por fãs foi descontinuado, e a API Fan Funding será desativada em 28 de fevereiro de 2017. Esse anúncio de suspensão de uso coincide com o lançamento do novo recurso Super Chat do YouTube.

Lista os eventos de financiamento por fãs para um canal. A solicitação da API precisa ser autorizada pelo proprietário do canal.

Solicitação

Solicitação HTTP

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

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 do recurso fanFundingEvent que serão incluídas pela resposta da API. Os valores aceitos são id e snippet.
Parâmetros opcionais
hl string
O parâmetro hl instrui a API a recuperar uma string de exibição de moeda localizada para um idioma do aplicativo compatível com o site do YouTube. Por exemplo, em inglês, a moeda seria exibida como $1.50, mas em francês, como 1,50$.

O valor do parâmetro precisa ser um código de idioma incluído na lista retornada pelo método i18nLanguages.list.
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 aceitos são de 0 a 50, inclusive. O valor padrão é 5.
pageToken string
O parâmetro pageToken identifica a página específica no conjunto de resultados que o servidor da API está sendo solicitado a retornar. Em uma resposta da API, a propriedade nextPageToken identifica a próxima página de resultados da solicitação.

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#fanFundingEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    fanFundingEvent 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#fanFundingEventListResponse.
etag etag
A ETag deste recurso.
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.
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 eventos de financiamento por fãs 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 visualizar os eventos do financiamento por fãs do canal.
invalidValue (400) fanFundingNotEnabledForChannelId O financiamento por fãs não está ativado no canal.

Confira!

Use o Explorador de API para chamar este método em dados ativos e ver a solicitação e a resposta da API.