Listar eventos do Super Chat das transmissões ao vivo de um canal nos últimos 30 dias.
Casos de uso comuns
Solicitação
Solicitação HTTP
GET https://www.googleapis.com/youtube/v3/superChatEvents
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 superChatEvent 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 o servidor da API a formatar o valor da propriedade snippet.displayString , que mostra o valor da compra e a moeda de um Super Chat, de acordo com as convenções de um determinado idioma. O valor do parâmetro precisa ser um código de idioma incluído na lista retornada pelo método i18nLanguages.list . O valor padrão é en , o que significa que o comportamento padrão é formatar as strings de exibição como elas seriam usadas em inglês. Por exemplo, por padrão, uma string é formatada como $1.00 em vez de $1,00 . |
|
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 1 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#superChatEventListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ superChatEvent 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#superChatEventListResponse . |
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 de compras de Super Chats que correspondem aos critérios de 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 |
A solicitação não está devidamente autorizada a recuperar eventos do Super Chat. |
Confira!
Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.