SuperChatEvents: list

Liste der Super Chat-Ereignisse aus den Livestreams eines Kanals in den letzten 30 Tagen.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

Autorisierung

Für diese Anfrage ist eine Autorisierung mit mindestens einem der folgenden Bereiche erforderlich. Weitere Informationen zu Authentifizierung und Autorisierung finden Sie unter OAuth 2.0-Authentifizierung implementieren.

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
Mit dem Parameter part werden die superChatEvent-Ressourcenteile angegeben, die in der API-Antwort enthalten sein sollen. Unterstützte Werte sind id und snippet.
Optionale Parameter
hl string
Der Parameter hl weist den API-Server an, den Attributwert snippet.displayString, der den Kaufbetrag und die Währung eines Super Chats enthält, gemäß den Konventionen einer bestimmten Sprache zu formatieren. Der Parameterwert muss ein Sprachcode sein, der in der Liste enthalten ist, die von der i18nLanguages.list-Methode zurückgegeben wird. Der Standardwert ist en. Das bedeutet, dass Anzeigestrings standardmäßig so formatiert werden, wie sie auf Englisch verwendet würden. Beispielsweise wird ein String standardmäßig als $1.00 statt als $1,00 formatiert.
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl der Elemente an, die im Ergebnissatz 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 werden mit den Eigenschaften nextPageToken und prevPageToken andere Seiten angegeben, die abgerufen werden könnten.

Anfragetext

Geben Sie beim Aufruf 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 sind die Eigenschaften aufgeführt, 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 in der Ergebnismenge abzurufen.
pageInfo object
Das pageInfo-Objekt enthält Informationen zur Paginierung für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse in der API-Antwort.
items[] list
Eine Liste der Super Chat-Käufe, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie in der Dokumentation zur Fehlermeldung.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) insufficientPermissions Die Anfrage ist nicht ordnungsgemäß autorisiert, Super Chat-Ereignisse abzurufen.

Testen!

Verwenden Sie die APIs Explorer, um diese API aufzurufen und die API-Anfrage und ‑Antwort zu sehen.