SuperChatEvents

Eine superChatEvent-Ressource stellt eine Super Chat-Nachricht dar, die von einem Fan während eines YouTube-Livestreams gekauft wurde. Im YouTube-Live-Chat-Stream heben sich Super Chats auf zwei Arten von anderen Nachrichten ab:

  • Super Chats werden farblich hervorgehoben.
  • Super Chats bleiben für eine bestimmte Zeit im Ticker angepinnt.

Die Farbe des Super Chats, die Zeit, für die er im Ticker angepinnt bleibt, und die maximale Nachrichtenlänge werden durch den Kaufbetrag bestimmt. Weitere Informationen zu Super Chats findest du in der YouTube-Hilfe.

Methoden

Die API unterstützt die folgenden Methoden für superChatEvents-Ressourcen:

list
Super Chat-Ereignisse aus den Livestreams eines Kanals in den letzten 30 Tagen auflisten Hier kannst du die Funktion ausprobieren.

Ressourcendarstellung

Die folgende JSON-Struktur zeigt das Format einer superChatEvent-Ressource:

{
  "kind": "youtube#superChatEvent",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "supporterDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "commentText": string,
    "createdAt": datetime,
    "amountMicros": unsigned long,
    "currency": string,
    "displayString": string,
    "messageType": unsigned integer,
    "isSuperStickerEvent": boolean,
    "superStickerMetadata": {
      "stickerId": string,
      "altText": string,
      "language": string
    }
  }
}

Attribute

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

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#superChatEvent.
etag etag
Das ETag dieser Ressource.
id string
Die ID, die YouTube zuweist, um das Super Chat-Ereignis eindeutig zu identifizieren.
snippet object
Das snippet-Objekt enthält grundlegende Details zum Super Chat-Ereignis.
snippet.channelId string
Die YouTube-Kanal-ID des Kanals, der den Livestream übertragen hat, der mit dem Super Chat-Ereignis verknüpft ist.
snippet.supporterDetails object
Details zum Kanal des Supporters.
snippet.supporterDetails.channelId string
Die YouTube-Kanal-ID des Supporters.
snippet.supporterDetails.channelUrl string
Die URL des Kanals des Supporters.
snippet.supporterDetails.displayName string
Der Anzeigename des Kanals des Supporters.
snippet.supporterDetails.profileImageUrl string
Die Avatar-URL für den Kanal des Supporters.
snippet.commentText string
Der Text des Kommentars des Supporters.
snippet.createdAt datetime
Datum und Uhrzeit, zu der der Super Chat gekauft wurde. Der Wert wird im ISO 8601-Format (YYYY-MM-DDThh:mm:ss.sZ) angegeben.
snippet.amountMicros unsigned long
Der Kaufbetrag in Mikros der Kaufwährung. Wenn der Kaufbetrag beispielsweise 1 $ beträgt, ist der Wert des Attributs snippet.amountMicros gleich 1000000.
snippet.currency string
Die Währung, in der der Kauf getätigt wurde. Der Wert ist ein ISO 4217-Währungscode.
snippet.displayString string
Ein String wie „$1.00“, der den Kaufbetrag und die Währung angibt. Der Anzeigestring wird gemäß den Konventionen für die Sprache formatiert, die durch den Anfrageparameter hl angegeben wird. Standardmäßig werden Anzeigestrings so formatiert, wie sie im Englischen aussehen würden. Standardmäßig wird ein String beispielsweise als $1.00 und nicht als $1,00 formatiert.
snippet.messageType unsigned integer
Die Stufe für die bezahlte Nachricht. Wenn eine liveChatMessage-Ressource eine Super Chat-Nachricht identifiziert, enthält das Attribut snippet.superChatDetails.tier diesen Wert.

Die Stufe basiert auf dem Betrag, der für den Kauf der Nachricht ausgegeben wurde. Sie bestimmt auch die Farbe, mit der die Nachricht in der Live-Chat-UI hervorgehoben wird, die maximale Nachrichtenlänge und die Zeit, für die die Nachricht im Ticker angepinnt wird.

Die Super Chat-Stufen sind in der YouTube-Hilfe dokumentiert. Weitere Informationen findest du im ausklappbaren Abschnitt zu Super Chat-Kaufdetails. In dieser Liste ist die Stufe mit dem niedrigsten Kaufbetrag Stufe 1, die nächstniedrigste Stufe 2 usw.
snippet.isSuperStickerEvent boolean
Gibt an, ob die Ressource ein Super Sticker ist. Das ist eine bestimmte Art von Super Chat-Nachricht mit einem zugehörigen Bild. Wenn der Wert dieses Felds true ist, enthält das Feld superStickerMetadata Informationen, die zum Anzeigen des Bildes verwendet werden können.
snippet.superStickerMetadata object
Details zum Super Sticker. Dieses Objekt wird nur zurückgegeben, wenn der Wert des Felds snippet.isSuperStickerEvent true ist.
snippet.superStickerMetadata.stickerId string
Eine eindeutige ID, die das Stickerbild identifiziert. Das Bild wird nur als Teil der Super Sticker-Nachricht angezeigt, wenn Nutzer das Chatfenster auf YouTube ansehen. Die Bild-URL ist jedoch nicht über die API verfügbar. In dieser CSV-Datei findest du eine Referenz, welche Sticker-IDs zu welchen Super Stickern gehören.
snippet.superStickerMetadata.altText string
Ein Textstring, der den Sticker beschreibt. Das Feld snippet.superStickerMetadata.language gibt die Sprache des Texts an. Wenn du die Methode superChatEvents.list aufrufst, lege den Parameterwert hl auf die gewünschte Sprache für den Text fest.
snippet.superStickerMetadata.language string
Die Sprache des Werts des Attributs snippet.superStickerMetadata.altText. Wenn im Super Sticker auch Text angezeigt wird, ist dieser Text ebenfalls in dieser Sprache.