SuperChatEvents

Eine superChatEvent-Ressource steht für eine Super Chat-Nachricht, die ein Fan während eines YouTube-Livestreams gekauft hat. Im Livechat auf YouTube können sich Super Chats von anderen Nachrichten auf zwei Arten abheben:

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

Die Farbe des Super Chats, die Dauer, für die er im Ticker angepinnt bleibt, und die maximale Nachrichtenlänge hängen vom Kaufbetrag ab. Weitere Informationen zu Super Chats findest du in der YouTube-Hilfe.

Methoden

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

list
Liste die Super Chat-Ereignisse aus den Livestreams eines Kanals in den letzten 30 Tagen auf. 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
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#superChatEvent.
etag etag
Das ETag dieser Ressource.
id string
Die ID, die YouTube zur eindeutigen Identifizierung des Super Chat-Ereignisses zuweist.
snippet object
Das Objekt snippet enthält grundlegende Details zum Super Chat-Ereignis.
snippet.channelId string
Die YouTube-Kanal-ID, die den Kanal identifiziert, über den der mit dem Super Chat-Ereignis verknüpfte Livestream übertragen wird.
snippet.supporterDetails object
Details zum Kanal des Unterstützer
snippet.supporterDetails.channelId string
Die YouTube-Kanal-ID des Unterstützer.
snippet.supporterDetails.channelUrl string
Die URL des Kanals des Unterstützer.
snippet.supporterDetails.displayName string
Der Anzeigename des Unterstützerkanals.
snippet.supporterDetails.profileImageUrl string
Die Avatar-URL für den Kanal des Unterstützer.
snippet.commentText string
Der Textinhalt des Kommentars des Unterstützer
snippet.createdAt datetime
Datum und Uhrzeit des Kaufs des Super Chats. Der Wert wird im Format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) angegeben.
snippet.amountMicros unsigned long
Der Kaufbetrag in millionstel Einheiten der Kaufwährung. Beträgt der Kaufbetrag beispielsweise einen Dollar, so lautet der Wert der snippet.amountMicros-Property 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 basierend auf den Konventionen für die Sprache formatiert, die im Anfrageparameter hl angegeben sind. Standardmäßig werden Anzeigezeichenfolgen wie in Englisch formatiert. Ein String hat beispielsweise standardmäßig das Format $1.00 und nicht $1,00.
snippet.messageType unsigned integer
Die Stufe für die kostenpflichtige Nachricht. Hinweis: Wenn eine liveChatMessage-Ressource eine Super Chat-Nachricht identifiziert, enthält die Property snippet.superChatDetails.tier diesen Wert.

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

Die Super Chat-Ebenen findest du in der YouTube-Hilfe. Weitere Informationen findest du im maximierbaren Abschnitt zu den Kaufdetails für Super Chat. In dieser Liste ist die Stufe mit dem niedrigsten Kaufbetrag Stufe 1, der nächstniedrigere Betrag ist Stufe 2 usw.
snippet.isSuperStickerEvent boolean
Gibt an, ob die Ressource ein Super Sticker ist. Das ist eine bestimmte Art von Super Chat-Nachricht, der ein Bild zugeordnet ist. Wenn der Wert dieses Felds true lautet, 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 kannst du nachsehen, 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 Textes an. Legen Sie beim Aufrufen der Methode superChatEvents.list für den Parameter hl die gewünschte Textsprache fest.
snippet.superStickerMetadata.language string
Die Sprache des Property-Werts snippet.superStickerMetadata.altText. Wenn im Super Sticker auch Text angezeigt wird, ist dieser Text ebenfalls in dieser Sprache.