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

LiveChatMessages

Une ressource liveChatMessage représente un message de chat dans un chat en direct YouTube. La ressource peut contenir des informations sur plusieurs types de messages, y compris un SMS récemment publié ou un événement de financement par les fans.

La fonctionnalité de chat en direct est activée par défaut pour les diffusions en direct et est disponible tant que l'événement en direct est actif. (Une fois l'événement terminé, le chat en direct n'est plus disponible.)

Méthodes

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

liste: Liste les messages d'un chat spécifique. Essayer
insérer: Ajoute un message à un chat en direct. Essayer maintenant
supprimer: Supprime un message de chat. La demande d'API doit être autorisée par le propriétaire de la chaîne ou un modérateur du chat en direct. Essayer

Représentation des ressources

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

{
  "kind": "youtube#liveChatMessage",
  "etag": etag,
  "id": string,
  "snippet": {
    "type": string,
    "liveChatId": string,
    "authorChannelId": string,
    "publishedAt": datetime,
    "hasDisplayContent": boolean,
    "displayMessage": string,
    "fanFundingEventDetails": {
      "amountMicros": unsigned long,
      "currency": string,
      "amountDisplayString": string,
      "userComment": string
    },
    "textMessageDetails": {
      "messageText": string
    },
    "messageDeletedDetails": {
      "deletedMessageId": string
    },
    "userBannedDetails": {
      "bannedUserDetails": {
        "channelId": string,
        "channelUrl": string,
        "displayName": string,
        "profileImageUrl": string
      },
      "banType": string,
      "banDurationSeconds": unsigned long
    },
    "memberMilestoneChatDetails": {
      "userComment": string,
      "memberMonth": unsigned integer,
      "memberLevelName": string
    },
    "newSponsorDetails": {
      "memberLevelName": string,
      "isUpgrade": bool
    },
    "superChatDetails": {
      "amountMicros": unsigned long,
      "currency": string,
      "amountDisplayString": string,
      "userComment": string,
      "tier": unsigned integer
    },
    "superStickerDetails": {
      "superStickerMetadata": {
        "stickerId": string,
        "altText": string,
        "language": string
      },
      "amountMicros": unsigned long,
      "currency": string,
      "amountDisplayString": string,
      "tier": unsigned integer
    },
    "membershipGiftingDetails": {
      "giftMembershipsCount": integer,
      "giftMembershipsLevelName": string
    },
    "giftMembershipReceivedDetails": {
      "memberLevelName": string,
      "gifterChannelId": string,
      "associatedMembershipGiftingMessageId": string
    },
  },
  "authorDetails": {
    "channelId": string,
    "channelUrl": string,
    "displayName": string,
    "profileImageUrl": string,
    "isVerified": boolean,
    "isChatOwner": boolean,
    "isChatSponsor": boolean,
    "isChatModerator": boolean
  },
}

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 d'API. La valeur est `youtube#liveChatMessage`.
`etag`	`etag` Etag de cette ressource.
`id`	`string` ID attribué par YouTube pour identifier de façon unique le message.
`snippet`	`object` L'objet `snippet` contient des informations essentielles sur le message de chat.
`snippet.type`	`string` Type du message. Cette propriété est toujours présente, et sa valeur détermine les champs présents dans la ressource. Les valeurs valides pour cette propriété sont les suivantes : `chatEndedEvent` : le chat est terminé, et plus aucun message ne peut être inséré après celui-ci. Cela se produit naturellement peu de temps après la fin d'une diffusion. Ce type de message n'est pas envoyé dans le chat en direct lors de la diffusion par défaut d'une chaîne. `messageDeletedEvent` : un message a été supprimé par un modérateur. Le champ `author` contient les informations du modérateur. Cet événement n'a aucun contenu d'affichage. `sponsorOnlyModeEndedEvent` : le chat n'est plus réservé aux soutiens, ce qui signifie que les utilisateurs qui ne sont pas des sponsors peuvent désormais envoyer des messages. Cet événement n'a aucun contenu d'affichage. `sponsorOnlyModeStartedEvent` : le chat est passé en mode Sponsors uniquement, ce qui signifie que seuls les sponsors peuvent envoyer des messages. Cet événement ne comporte aucun contenu à afficher. `newSponsorEvent` : un nouvel utilisateur a sponsorisé la chaîne à laquelle appartient le chat en direct. Les champs `author` contiennent les informations du nouveau sponsor. `memberMilestoneChatEvent` : un utilisateur a envoyé un chat de fidélité pour les membres. `superChatEvent` : un utilisateur a acheté un Super Chat. `superStickerEvent` : un utilisateur a acheté un Super Sticker. `textMessageEvent` : un utilisateur a envoyé un SMS. `tombstone` : un tombstone signifie qu'un message avec cet ID et cette heure de publication existait auparavant, mais il a depuis été supprimé. Il n'est pas envoyé lors de la suppression d'un message, mais il indique où se trouvait le message avant sa suppression. Seuls les champs `snippet.liveChatId`, `snippet.type` et `snippet.publishedAt` sont présents dans ce type de message. `userBannedEvent` : un utilisateur a été exclu par un modérateur. Le champ `author` contient les informations du modérateur. `membershipGiftingEvent` : un utilisateur a acheté des souscriptions pour d'autres spectateurs. `giftMembershipReceivedEvent` : un utilisateur a reçu une souscription sans frais.
`snippet.liveChatId`	`string` ID qui identifie de manière unique le chat en direct auquel le message est associé. L'ID de chat en direct associé à une diffusion est renvoyé dans la propriété `snippet.liveChatId` de la ressource `liveBroadcast`.
`snippet.authorChannelId`	`string` L'ID de l'utilisateur qui a créé le message. Ce champ n'est renseigné que pour les types de messages suivants : Si le type de message est `textMessageEvent`, la valeur de la propriété identifie l'utilisateur qui a écrit le message. Si le type de message est `fanFundingEvent`, la valeur de la propriété identifie l'utilisateur qui a financé la diffusion. Si le message est de type `messageDeletedEvent`, la valeur de la propriété identifie le modérateur qui a supprimé le message. Si le type de message est `newSponsorEvent`, la valeur de la propriété identifie l'utilisateur qui vient de devenir sponsor. Si le message est de type `memberMilestoneChatEvent`, la valeur de la propriété identifie le membre qui a envoyé le message. Si le message est de type `userBannedEvent`, la valeur de la propriété identifie le modérateur qui a exclu l'utilisateur. Si le type de message est `membershipGiftingEvent`, la valeur de la propriété identifie l'utilisateur qui a effectué l'achat pour offrir une souscription. Si le type de message est `giftMembershipReceivedEvent`, la valeur de la propriété identifie l'utilisateur qui a reçu la souscription sans frais.
`snippet.publishedAt`	`datetime` Date et heure de publication initiale du message. La valeur est spécifiée au format ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`).
`snippet.hasDisplayContent`	`boolean` Indique si le message comporte du contenu à afficher auprès des utilisateurs.
`snippet.displayMessage`	`string` Contient une chaîne présentée aux utilisateurs. Ce champ n'est pas présent si le type de message est `chatEndedEvent` ou `tombstone`.
`snippet.fanFundingEventDetails`	`object` Remarque: Cet objet et ses propriétés enfants ont été abandonnés. Depuis le 28 février 2017, les ressources `liveChatMessage` ne renvoient plus d'informations sur les événements de financement par les fans. Cet objet contient des informations sur l'événement ayant fait l'objet d'un financement. Il n'est présent que si le type de message est `fanFundingEvent`.
`snippet.fanFundingEventDetails.amountMicros`	`unsigned long` Remarque: Cette propriété a été abandonnée. Montant du fonds.
`snippet.fanFundingEventDetails.currency`	`string` Remarque: Cette propriété a été abandonnée. Devise dans laquelle le fonds a été créé.
`snippet.fanFundingEventDetails.amountDisplayString`	`string` Remarque: Cette propriété a été abandonnée. Chaîne affichée qui présente le montant du fonds et la devise à l'utilisateur.
`snippet.fanFundingEventDetails.userComment`	`string` Remarque: Cette propriété a été abandonnée. Commentaire ajouté par l'utilisateur à cet événement de financement par les fans.
`snippet.textMessageDetails`	`object` Cet objet contient des informations sur le message texte. Il n'est présent que si le type de message est `textMessageEvent`.
`snippet.textMessageDetails.messageText`	`string` Message de l'utilisateur.
`snippet.messageDeletedDetails`	`object` Cet objet contient les détails d'un message supprimé par un modérateur de chat ou par le propriétaire de la chaîne de la diffusion en direct. Il n'est présent que si le type de message est `messageDeletedEvent`.
`snippet.messageDeletedDetails.deletedMessageId`	`string` L'ID qui identifie de manière unique le message supprimé. Cette valeur est identique à celle de la propriété `id` du message texte d'origine. Par exemple, si la valeur de la propriété `id` d'un `textMessageEvent` est `123`, et que ce message est ensuite supprimé, la valeur `snippet.messageDeletedDetails.deletedMessageId` sera `123` pour ce message. Si vous mettez en cache les messages de chat après les avoir récupérés, utilisez la valeur de cette propriété pour identifier le message qui ne doit plus être affiché.
`snippet.userBannedDetails`	`object` Cet objet contient des informations sur un utilisateur qui a été exclu du chat. Elle contient également des informations sur l'exclusion elle-même. Les utilisateurs peuvent être exclus définitivement ou temporairement d'un chat.
`snippet.userBannedDetails.bannedUserDetails`	`object` Cet objet contient des informations sur l'utilisateur exclu.
`snippet.userBannedDetails.bannedUserDetails.channelId`	`string` ID de la chaîne YouTube de l'utilisateur exclu.
`snippet.userBannedDetails.bannedUserDetails.channelUrl`	`string` URL de la chaîne YouTube de l'utilisateur exclu.
`snippet.userBannedDetails.bannedUserDetails.displayName`	`string` Nom à afficher de la chaîne YouTube de l'utilisateur exclu.
`snippet.userBannedDetails.bannedUserDetails.profileImageUrl`	`string` Avatar de la chaîne YouTube de l'utilisateur exclu.
`snippet.userBannedDetails.banType`	`string` Type d'exclusion. Les valeurs valides pour cette propriété sont les suivantes: permanente Provisoire
`snippet.userBannedDetails.banDurationSeconds`	`unsigned long` Durée de l'exclusion. Cette propriété n'est présente que si la valeur de la propriété `snippet.userBannedDetails.banType` est `temporary`.
`snippet.memberMilestoneChatDetails`	`object` Cet objet contient des informations sur un événement de jalon de membre. Il n'est présent que si le type de message est `memberMilestoneChatEvent`.
`snippet.memberMilestoneChatDetails.userComment`	`string` Commentaire ajouté par le membre dans ce chat de fidélité. Ce champ est vide pour les messages sans commentaire du membre.
`snippet.memberMilestoneChatDetails.memberMonth`	`unsigned integer` Nombre total de mois (arrondi) pendant lesquels le spectateur est membre et lui accorde ce chat de fidélité. Il s'agit du même nombre de mois que celui qui s'affiche pour les utilisateurs YouTube.
`snippet.memberMilestoneChatDetails.memberLevelName`	`string` Nom du niveau auquel le spectateur est membre. Les noms des niveaux sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.newSponsorDetails`	`object` Cet objet contient des informations sur l'événement "Annonce à un nouveau membre". Il n'est défini que si le type est `newSponsorEvent`. "Membre" est le terme pour "sponsor".
`snippet.newSponsorDetails.memberLevelName`	`string` Nom du niveau auquel le spectateur est membre. Les noms des niveaux sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.newSponsorDetails.isUpgrade`	`bool` Indique si le spectateur vient de passer à un niveau supérieur. Pour les spectateurs qui n'étaient pas membres au moment de l'achat, la valeur du champ est `false`.
`snippet.superChatDetails`	`object` Cet objet contient des informations sur un événement Super Chat. Il n'est présent que si le type de message est `superChatEvent`.
`snippet.superChatDetails.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.superChatDetails.currency`	`string` Devise dans laquelle l'achat a été effectué. Il s'agit d'un code de devise ISO 4217.
`snippet.superChatDetails.amountDisplayString`	`string` Une chaîne (par exemple, `$1.00`) contenant le montant de l'achat et la devise. La chaîne est destinée à être présentée à l'utilisateur.
`snippet.superChatDetails.userComment`	`string` Commentaire ajouté par l'utilisateur à cet événement Super Chat.
`snippet.superChatDetails.tier`	`unsigned integer` Niveau pour le message payant. Notez que dans une ressource `superChatEvent`, la propriété `snippet.messageType` 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. Pour en savoir plus sur les niveaux de Super Chat, consultez le Centre d'aide YouTube. (voir la section à développer sur les achats de Super Chats). Dans cette liste, le niveau avec le montant d'achat le plus faible est le niveau 1, le niveau suivant le niveau 2, et ainsi de suite.
`snippet.superStickerDetails`	`object` Cet objet contient des informations sur un événement Super Sticker. Il n'est présent que si le type de message est `superStickerEvent`.
`snippet.superStickerDetails.superStickerMetadata`	`object` Informations sur le Super Sticker
`snippet.superStickerDetails.superStickerMetadata.stickerId`	`string` 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. Cependant, l'URL de l'image n'est pas disponible à l'aide de l'API. Pour information, vous pouvez trouver les ID d'autocollants associés aux Super Stickers dans ce fichier CSV.
`snippet.superStickerDetails.superStickerMetadata.altText`	`string` Chaîne de texte décrivant l'autocollant. Le champ `snippet.superStickerDetails.superStickerMetadata.language` identifie la langue du texte. Lorsque vous appelez la méthode `liveChatMessages.list`, définissez la valeur du paramètre hl sur la langue choisie pour le texte.
`snippet.superStickerDetails.superStickerMetadata.language`	`string` Langue de la valeur de la propriété `snippet.superStickerDetails.superStickerMetadata.altText`.
`snippet.superStickerDetails.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.superStickerDetails.currency`	`string` Devise dans laquelle l'achat a été effectué. Il s'agit d'un code de devise ISO 4217.
`snippet.superStickerDetails.amountDisplayString`	`string` Une chaîne (par exemple, `$1.00`) contenant le montant de l'achat et la devise. La chaîne est destinée à être présentée à l'utilisateur.
`snippet.superStickerDetails.tier`	`unsigned integer` Niveau pour le message payant. Notez que dans une ressource `superChatEvent`, la propriété `snippet.messageType` 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 il est épinglé dans le bandeau. Les niveaux des Super Chats, qui couvrent également les Super Stickers, sont détaillés dans le Centre d'aide YouTube. (voir la section à développer sur les achats de Super Chats). Dans cette liste, le niveau avec le montant d'achat le plus faible est le niveau 1, le niveau suivant le niveau 2, et ainsi de suite.
`snippet.pollDetails`	`object` Cet objet contient des informations sur un événement de sondage. Il n'est présent que si le type de message est `pollEvent`.
`snippet.pollDetails.metadata`	`object` Informations sur l'événement de sondage.
`snippet.pollDetails.metadata.options`	`object` Options du sondage en direct
`snippet.pollDetails.metadata.options.optionText`	`string` Texte de l'option de sondage en direct.
`snippet.pollDetails.metadata.options.questionText`	`string` Texte de la question du sondage en direct.
`snippet.pollDetails.metadata.status`	`enum` État du sondage en direct. Les valeurs valides pour cette propriété sont les suivantes : `unknown` `active` `closed`
`snippet.membershipGiftingDetails`	`object` Cet objet contient des informations sur un événement "Offrir une souscription". Il n'est présent que si `message type` est défini sur `membershipGiftingEvent`.
`snippet.membershipGiftingDetails.giftMembershipsCount`	`integer` Nombre de souscriptions sans frais achetées par l'utilisateur.
`snippet.membershipGiftingDetails.giftMembershipsLevelName`	`string` Nom du niveau des souscriptions sans frais achetées par l'utilisateur. Les noms des niveaux sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.giftMembershipReceivedDetails`	`object` Cet objet contient des détails sur un événement "Offrir une souscription". Il n'est présent que si `message type` est défini sur `giftMembershipReceivedEvent`.
`snippet.giftMembershipReceivedDetails.memberLevelName`	`string` Nom du niveau auquel le spectateur est membre. Il correspond à l'`snippet.membershipGiftingDetails.giftMembershipsLevelName` du message associé pour offrir une souscription. Les noms des niveaux sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.giftMembershipReceivedDetails.gifterChannelId`	`string` ID de l'utilisateur qui a acheté la souscription à offrir. Il correspond à l'`snippet.authorChannelId` du message associé pour offrir une souscription.
`snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId`	`string` ID du message pour offrir une souscription en lien avec cette souscription sans frais. Cet ID fait toujours référence à un message dont le champ `type` est `membershipGiftingEvent`.
`authorDetails`	`object` L'objet `authorDetails` contient des informations supplémentaires sur l'utilisateur qui a publié ce message.
`authorDetails.channelId`	`string` ID de la chaîne YouTube de l'auteur.
`authorDetails.channelUrl`	`string` URL de la chaîne YouTube de l'auteur.
`authorDetails.displayName`	`string` Nom à afficher de la chaîne YouTube de l'auteur.
`authorDetails.profileImageUrl`	`string` URL de l'avatar de la chaîne YouTube de l'auteur.
`authorDetails.isVerified`	`boolean` Cette valeur indique si l'identité de l'auteur a été validée par YouTube.
`authorDetails.isChatOwner`	`boolean` Cette valeur indique si l'auteur est le propriétaire du chat en direct.
`authorDetails.isChatSponsor`	`boolean` Cette valeur indique si l'auteur sponsorise le chat en direct.
`authorDetails.isChatModerator`	`boolean` Cette valeur indique si l'auteur est un modérateur du chat en direct.