SuperChatEvents

Une ressource superChatEvent représente un message Super Chat acheté par un fan lors d'une diffusion en direct YouTube. Dans le flux de chat en direct YouTube, les Super Chats se distinguent des autres messages de deux manières :

  • Les Super Chats sont mis en surbrillance avec une couleur.
  • Ils restent épinglés dans le ticker pendant une période définie.

La couleur du Super Chat, la période pendant laquelle il reste épinglé dans le ticker et la longueur maximale du message sont toutes déterminées par le montant de l'achat. Pour en savoir plus sur les Super Chats, consultez le Centre d'aide YouTube.

Méthodes

L'API est compatible avec les méthodes suivantes pour les ressources superChatEvents :

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

Représentation de la ressource

La structure JSON suivante montre le format d'une ressource superChatEvent :

{
  "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
    }
  }
}

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 ressource de l'API. La valeur sera youtube#superChatEvent.
etag etag
Etag de cette ressource.
id string
ID que YouTube attribue pour identifier de manière unique l'événement Super Chat.
snippet object
L'objet snippet contient des informations de base sur l'événement Super Chat.
snippet.channelId string
ID de la chaîne YouTube qui identifie la chaîne ayant diffusé le flux en direct associé à l'événement Super Chat.
snippet.supporterDetails object
Informations sur la chaîne du spectateur.
snippet.supporterDetails.channelId string
ID de la chaîne YouTube du spectateur.
snippet.supporterDetails.channelUrl string
URL de la chaîne du spectateur.
snippet.supporterDetails.displayName string
Nom à afficher de la chaîne du spectateur.
snippet.supporterDetails.profileImageUrl string
URL de l'avatar de la chaîne du spectateur.
snippet.commentText string
Contenu textuel du commentaire du spectateur.
snippet.createdAt datetime
Date et heure d'achat du Super Chat. La valeur est spécifiée au format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.amountMicros unsigned long
Montant de l'achat, en micros de la devise d'achat. Par exemple, si le montant de l'achat est d'un dollar, la valeur de la propriété snippet.amountMicros est 1000000.
snippet.currency string
Devise dans laquelle l'achat a été effectué. La valeur est un code de la devise ISO 4217.
snippet.displayString string
Chaîne, comme $1.00, qui indique le montant de l'achat et la devise. La chaîne à afficher est mise en forme en fonction des conventions de la langue spécifiée par le paramètre de requête hl. Par défaut, les chaînes à afficher sont mises en forme comme elles le seraient en anglais. Par exemple, par défaut, une chaîne est mise en forme comme $1.00 plutôt que $1,00.
snippet.messageType unsigned integer
Niveau du message payant. Notez que lorsqu'une ressource liveChatMessage identifie un message Super Chat, la propriété snippet.superChatDetails.tier contient cette valeur.

Le niveau est basé sur le montant dépensé pour acheter le message. Il détermine également la couleur utilisée pour mettre en surbrillance le message dans l'interface utilisateur du chat en direct, la longueur maximale du message et la durée pendant laquelle le message est épinglé dans le ticker.

Les niveaux de Super Chat sont décrits dans le Centre d'aide YouTube. (Consultez la section extensible sur les informations d'achat des Super Chats.) Dans cette liste, le niveau avec le montant de l'achat le plus bas est le niveau 1, le montant le plus bas suivant est le niveau 2, et ainsi de suite.
snippet.isSuperStickerEvent boolean
Indique si la ressource est un Super Sticker, qui est un type particulier de message Super Chat associé à une image. Si la valeur de ce champ est true, le champ superStickerMetadata contient des informations qui peuvent être utilisées pour afficher l'image.
snippet.superStickerMetadata object
Informations sur le Super Sticker. Cet objet n'est renvoyé que si la valeur du champ snippet.isSuperStickerEvent est true.
snippet.superStickerMetadata.stickerId string
Un identifiant unique qui identifie l'image de l'autocollant. Notez que l'image ne s'affiche que dans le message Super Sticker lorsque les utilisateurs consultent la fenêtre de chat sur YouTube. Toutefois, l'URL de l'image n'est pas disponible via l'API. À titre de référence uniquement, vous pouvez trouver les ID de stickers associés aux Super Stickers dans ce fichier CSV.
snippet.superStickerMetadata.altText string
Chaîne de texte qui décrit le sticker. Le champ snippet.superStickerMetadata.language identifie la langue du texte. Lorsque vous appelez la méthode superChatEvents.list, définissez la valeur de paramètre hl sur la langue souhaitée pour le texte.
snippet.superStickerMetadata.language string
Langue de la valeur de la propriété snippet.superStickerMetadata.altText. Si le Super Sticker affiche également du texte, il est également dans cette langue.