SuperChatEvents: list

Elenca gli eventi Superchat dei live streaming di un canale negli ultimi 30 giorni.

Casi d'uso comuni

Richiesta

Richiesta HTTP

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

Autorizzazione

Questa richiesta richiede l'autorizzazione con almeno uno dei seguenti ambiti. Per saperne di più sull'autenticazione e sull'autorizzazione, consulta Implementazione dell'autenticazione OAuth 2.0.

Ambito
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Parametri

La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.

Parametri
Parametri obbligatori
part string
Il parametro part specifica le parti della risorsa superChatEvent che verranno incluse nella risposta dell'API. I valori supportati sono id e snippet.
Parametri facoltativi
hl string
Il parametro hl indica al server API di formattare il valore della proprietà snippet.displayString, che mostra l'importo e la valuta di acquisto di una Super Chat, in base alle convenzioni di una determinata lingua. Il valore del parametro deve essere un codice lingua incluso nell'elenco restituito dal metodo i18nLanguages.list. Il valore predefinito è en, il che significa che il comportamento predefinito è formattare le stringhe di visualizzazione come verrebbero utilizzate in inglese. Ad esempio, per impostazione predefinita, una stringa è formattata come $1.00 anziché $1,00.
maxResults unsigned integer
Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati. I valori accettabili sono compresi tra 1 e 50. Il valore predefinito è 5.
pageToken string
Il parametro pageToken identifica una pagina specifica del set di risultati da restituire. In una risposta dell'API, le proprietà nextPageToken e prevPageToken identificano altre pagine che potrebbero essere recuperate.

Corpo della richiesta

Non fornire un corpo della richiesta quando chiami questo metodo.

Risposta

In caso di esito positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:

{
  "kind": "youtube#superChatEventListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    superChatEvent resource
  ]
}

Proprietà

La tabella seguente definisce le proprietà visualizzate in questa risorsa:

Proprietà
kind string
Identifica il tipo di risorsa API. Il valore sarà youtube#superChatEventListResponse.
etag etag
L'ETag di questa risorsa.
nextPageToken string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati.
pageInfo object
L'oggetto pageInfo racchiude le informazioni di paginazione per il set di risultati.
pageInfo.totalResults integer
Il numero totale di risultati nel set di risultati.
pageInfo.resultsPerPage integer
Il numero di risultati inclusi nella risposta dell'API.
items[] list
Un elenco di acquisti di Superchat che corrispondono ai criteri di richiesta.

Errori

La seguente tabella identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per ulteriori dettagli, consulta la documentazione relativa al messaggio di errore.

Tipo di errore Dettaglio errore Descrizione
forbidden (403) insufficientPermissions La richiesta non è autorizzata correttamente a recuperare gli eventi Superchat.

Prova

Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.