SuperChatEvents: list

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

Cas d'utilisation courants

Requête

Requête HTTP

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

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants. Pour en savoir plus sur l'authentification et l'autorisation, consultez Implémenter l'authentification OAuth 2.0.

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 présente les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
part	string Le paramètre part spécifie les parties de la ressource superChatEvent que la réponse de l'API inclura. Les valeurs acceptées sont id et snippet.
Paramètres facultatifs
hl	string Le paramètre hl indique au serveur de l'API de mettre en forme la valeur de la propriété snippet.displayString, qui indique le montant de l'achat et la devise d'un Super Chat, conformément aux 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 formatage des chaînes d'affichage est défini par défaut comme s'il était utilisé en anglais. Par exemple, par défaut, une chaîne est formatée en $1.00 plutôt qu'en $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 acceptées sont comprises entre 1 et 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 pouvant ê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 la 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 récupérer 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 Super Chat correspondant aux critères de la requête.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de cette méthode. Pour en savoir plus, consultez la documentation sur le message d'erreur.

Type d'erreur	Détail de l'erreur	Description
forbidden (403)	insufficientPermissions	La demande 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 et la réponse de l'API.