SuperChatEvents: list

Du kannst Super Chat-Ereignisse aus den Livestreams eines Kanals in den letzten 30 Tagen auflisten.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

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

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

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

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
part string
Der Parameter part gibt die superChatEvent-Ressourcenteile an, die die API-Antwort enthalten soll. Unterstützte Werte sind id und snippet.
Optionale Parameter
hl string
Der Parameter hl weist den API-Server an, den Property-Wert snippet.displayString zu formatieren, der den Kaufbetrag und die Währung eines Super Chats gemäß den Konventionen einer bestimmten Sprache anzeigt. Der Parameterwert muss ein Sprachcode sein, der in der Liste enthalten ist, die von der Methode i18nLanguages.list zurückgegeben wird. Der Standardwert ist en. Das bedeutet, dass Displaystrings standardmäßig so formatiert werden, wie sie auf Englisch verwendet würden. Ein String hat beispielsweise standardmäßig das Format $1.00 statt $1,00.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen. Zulässige Werte sind 1 bis 50. Der Standardwert ist 5.
pageToken string
Der Parameter pageToken gibt eine bestimmte Seite im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute nextPageToken und prevPageToken andere Seiten, die abgerufen werden können.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

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

Attribute

In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#superChatEventListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite im Ergebnissatz abzurufen.
pageInfo object
Das pageInfo-Objekt enthält Seiteninformationen für die Ergebnismenge.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse in der Ergebnismenge.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
items[] list
Eine Liste von Super Chat-Käufen, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) insufficientPermissions Die Anfrage ist nicht berechtigt, Super Chat-Ereignisse abzurufen.

Testen!

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.