Cette page a été traduite par l'API Cloud Translation.

SuperChatEvents

Une ressource superChatEvent représente un message Super Chat acheté par un fan lors d'une diffusion en direct YouTube. Dans le chat en direct YouTube, les messages Super Chat se démarquent des autres de deux façons:

Les Super Chats sont signalés par une couleur.
Les Super Chats restent épinglés dans le flux pendant une période donnée.

La couleur du Super Chat, la durée pendant laquelle il reste épinglé dans le flux et sa longueur maximale sont déterminés par le montant de l'achat. Consultez le Centre d'aide YouTube pour en savoir plus sur les Super Chats.

Méthodes

L'API accepte les méthodes suivantes pour les ressources superChatEvents:

list: Répertorier les événements Super Chat des diffusions en direct d'une chaîne au cours des 30 derniers jours Essayer

Représentation des ressources

La structure JSON suivante illustre 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 API. La valeur est `youtube#superChatEvent`.
`etag`	`etag` Etag de cette ressource.
`id`	`string` ID attribué par YouTube pour identifier l'événement Super Chat de manière unique.
`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 qui a diffusé la diffusion en direct associée à l'événement Super Chat.
`snippet.supporterDetails`	`object` Informations sur la chaîne du sympathisant.
`snippet.supporterDetails.channelId`	`string` ID de la chaîne YouTube du sympathisant.
`snippet.supporterDetails.channelUrl`	`string` URL de la chaîne du sympathisant.
`snippet.supporterDetails.displayName`	`string` Nom à afficher de la chaîne du sympathisant.
`snippet.supporterDetails.profileImageUrl`	`string` URL de l'avatar de la chaîne du sympathisant.
`snippet.commentText`	`string` Le contenu textuel du commentaire du sympathisant.
`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 micro-unités 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 devise ISO 4217.
`snippet.displayString`	`string` Une chaîne (par exemple, `$1.00`) qui indique le montant de l'achat et la devise. Le format de la chaîne à afficher respecte les conventions de la langue spécifiée par le paramètre de requête `hl`. Par défaut, les chaînes d'affichage sont mises en forme comme en anglais. Par exemple, le format par défaut d'une chaîne est `$1.00` au lieu de `$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. Elles déterminent également la couleur utilisée pour mettre le message en surbrillance dans l'interface utilisateur du chat en direct, sa longueur maximale et la durée pendant laquelle le message est épinglé dans le bandeau. Les niveaux de Super Chat sont présentés dans le Centre d'aide YouTube. (Consultez la section à développer sur les détails des achats Super Chat.) Dans cette liste, le niveau avec le montant d'achat le plus faible est le niveau 1, le niveau le plus bas est le niveau 2, et ainsi de suite.
`snippet.isSuperStickerEvent`	`boolean` Indique si la ressource est un Super Sticker. Il s'agit d'un type particulier de message Super Chat auquel une image est associée. 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 les Super Stickers Cet objet n'est renvoyé que si la valeur du champ `snippet.isSuperStickerEvent` est `true`.
`snippet.superStickerMetadata.stickerId`	`string` Identifiant unique qui identifie l'image de l'autocollant. Sachez que l'image ne s'affiche que dans le message Super Sticker lorsque les utilisateurs consultent la fenêtre de chat sur YouTube. Cependant, l'URL de l'image n'est pas disponible via l'API. Pour information, vous pouvez trouver les ID d'autocollant associés aux Super Stickers dans ce fichier CSV.
`snippet.superStickerMetadata.altText`	`string` Chaîne de texte décrivant l'autocollant. Le champ `snippet.superStickerMetadata.language` identifie la langue du texte. Lorsque vous appelez la méthode `superChatEvents.list`, définissez la valeur du 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 l'est également dans cette langue.