SuperChatEvents: list

Répertorier les événements Super Chat des diffusions en direct d'une chaîne au cours des 30 derniers jours

Cas d'utilisation courants

Demande

Requête HTTP :

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

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Portée
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Réglages obligatoires
part string
Le paramètre part spécifie les parties de la ressource superChatEvent qui seront incluses dans la réponse de l'API. Les valeurs acceptées sont id et snippet.
Paramètres facultatifs
hl string
Le paramètre hl indique au serveur d'API de mettre en forme la valeur de la propriété snippet.displayString, qui indique le montant et la devise des Super Chats selon les conventions d'une langue donnée. La valeur du paramètre doit être un code de langue inclus dans la liste renvoyée par la méthode i18nLanguages.list. La valeur par défaut est en, ce qui signifie que le comportement par défaut consiste à formater les chaînes d'affichage telles qu'elles seraient utilisées en anglais. Par exemple, par défaut, une chaîne est au format $1.00 au lieu de $1,00.
maxResults unsigned integer
Le paramètre maxResults spécifie le nombre maximal d'éléments à renvoyer dans l'ensemble de résultats. Les valeurs autorisées vont de 1 à 50, inclus. La valeur par défaut est 5.
pageToken string
Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse d'API, les propriétés nextPageToken et prevPageToken identifient d'autres pages qui pourraient être récupérées.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

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

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans cette ressource:

Propriétés
kind string
Identifie le type de ressource de l'API. La valeur sera youtube#superChatEventListResponse.
etag etag
ETag de cette ressource.
nextPageToken string
Jeton pouvant être utilisé comme valeur du paramètre pageToken pour extraire la page suivante de l'ensemble de résultats.
pageInfo object
L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults integer
Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage integer
Nombre de résultats inclus dans la réponse de l'API.
items[] list
Liste des achats de messages Super Chat répondant aux critères de demande.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API pourrait renvoyer en réponse à un appel à cette méthode. Veuillez consulter la documentation sur les messages d'erreur pour en savoir plus.

Type d'erreur Détails de l'erreur Description
forbidden (403) insufficientPermissions La requête n'est pas correctement autorisée à récupérer les événements Super Chat.

Essayer

Utilisez APIs Explorer pour appeler cette API et afficher la requête API et la réponse.