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 message texte ou un événement de financement par les fans récemment publiés.

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 pour cet événement.)

Méthodes

L'API prend en charge les méthodes suivantes pour les ressources liveChatMessages:

liste: Liste les messages du chat en direct pour un chat spécifique. Essayer
insérer: Permet d'ajouter un message ou un sondage à un chat en direct. Essayer
transition: Transfère l'état d'un message diffusé. Essayer
supprimer: Supprime un message de chat. La requête API doit être autorisée par le propriétaire de la chaîne ou un modérateur du chat en direct. Essayer

Représentation de la ressource

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
    },
    "pollDetails": {
      "metadata": {
        "options": {
          "optionText": string,
          "tally": string,
        },
        "questionText": string,
        "status": enum
      },
    },
    "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 la ressource API. La valeur sera `youtube#liveChatMessage`.
`etag`	`etag` Etag de cette ressource.
`id`	`string` ID attribué par YouTube pour identifier de manière unique le message.
`snippet`	`object` L'objet `snippet` contient les informations principales sur le message 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. Valeurs valides pour cette propriété : `chatEndedEvent` : la discussion est terminée et aucun message ne peut plus ê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é pour les chats en direct sur 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 sur le modérateur. Cet événement n'a aucun contenu à afficher. `sponsorOnlyModeEndedEvent` : la discussion n'est plus en mode "Sponsors uniquement", ce qui signifie que les utilisateurs qui ne sont pas sponsors peuvent désormais envoyer des messages. Cet événement n'a aucun contenu à afficher. `sponsorOnlyModeStartedEvent` : le chat est passé en mode Sponsors uniquement, ce qui signifie que seuls les sponsors peuvent envoyer des messages. Cet événement n'a pas de contenu à afficher. `newSponsorEvent` : un nouvel utilisateur a sponsorisé la chaîne propriétaire du 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 message de type "tombstone" indique qu'un message existait avec cet ID et cette heure de publication, mais qu'il a été supprimé depuis. Il n'est pas envoyé lors de la suppression d'un message, mais s'affiche pour indiquer l'emplacement du 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é banni par un modérateur. Le champ `author` contient les informations sur le modérateur. `membershipGiftingEvent` : un utilisateur a acheté des souscriptions pour d'autres spectateurs. `giftMembershipReceivedEvent` : un utilisateur a reçu une souscription sans frais. `pollDetails` : un utilisateur a créé un sondage en direct.
`snippet.liveChatId`	`string` ID qui identifie de manière unique le chat en direct auquel le message est associé. L'ID du chat en direct associé à une diffusion est renvoyé dans la propriété `snippet.liveChatId` de la ressource `liveBroadcast`.
`snippet.authorChannelId`	`string` ID de l'utilisateur à l'origine du 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 type de message est `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 type de message est `memberMilestoneChatEvent`, la valeur de la propriété identifie le membre qui a envoyé le message. Si le type de message est `userBannedEvent`, la valeur de la propriété identifie le modérateur qui a banni l'utilisateur. Si le type de message est `membershipGiftingEvent`, la valeur de la propriété identifie l'utilisateur qui a effectué l'achat d'abonnement en cadeau. Si le type de message est `giftMembershipReceivedEvent`, la valeur de la propriété identifie l'utilisateur qui a reçu l'abonnement sans frais. Si le type de message est `pollEvent`, la valeur de la propriété identifie l'utilisateur qui a créé un sondage en direct.
`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 contient un contenu à afficher pour les utilisateurs.
`snippet.displayMessage`	`string` contient une chaîne qui s'affiche pour les 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 sont obsolètes. Depuis le 28 février 2017, les ressources `liveChatMessage` ne renvoient plus de détails sur les événements de financement par les fans. Cet objet contient des informations sur l'événement de financement. Il n'est présent que si le type de message est `fanFundingEvent`.
`snippet.fanFundingEventDetails.amountMicros`	`unsigned long` Remarque: Cette propriété est obsolète. Montant du fonds.
`snippet.fanFundingEventDetails.currency`	`string` Remarque: Cette propriété est obsolète. Devise dans laquelle le financement a été effectué.
`snippet.fanFundingEventDetails.amountDisplayString`	`string` Remarque: Cette propriété est obsolète. Chaîne affichée qui indique le montant du financement 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 des informations sur 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` ID qui identifie de manière unique le message supprimé. La 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 s'afficher.
`snippet.userBannedDetails`	`object` Cet objet contient des informations sur un utilisateur qui a été banni du chat. Il contient également des informations sur l'interdiction elle-même. Les utilisateurs peuvent être bannis d'un chat de façon permanente ou temporaire.
`snippet.userBannedDetails.bannedUserDetails`	`object` Cet objet contient des informations sur l'utilisateur banni.
`snippet.userBannedDetails.bannedUserDetails.channelId`	`string` ID de la chaîne YouTube de l'utilisateur banni.
`snippet.userBannedDetails.bannedUserDetails.channelUrl`	`string` URL de la chaîne YouTube de l'utilisateur banni.
`snippet.userBannedDetails.bannedUserDetails.displayName`	`string` Nom à afficher de la chaîne YouTube de l'utilisateur banni.
`snippet.userBannedDetails.bannedUserDetails.profileImageUrl`	`string` Avatar de la chaîne YouTube de l'utilisateur banni.
`snippet.userBannedDetails.banType`	`string` Type d'interdiction. Les valeurs valides pour cette propriété sont les suivantes: permanente Provisoire
`snippet.userBannedDetails.banDurationSeconds`	`unsigned long` Durée de l'interdiction. 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 pour les membres. Il n'est présent que si le type de message est `memberMilestoneChatEvent`.
`snippet.memberMilestoneChatDetails.userComment`	`string` Commentaire ajouté par le membre à ce chat de fidélité pour les membres. Ce champ est vide pour les messages sans commentaire du membre.
`snippet.memberMilestoneChatDetails.memberMonth`	`unsigned integer` Nombre total de mois (arrondi à la hausse) pendant lesquels le spectateur a été membre et a reçu ce chat de fidélité. Il s'agit du même nombre de mois que celui affiché aux utilisateurs de YouTube.
`snippet.memberMilestoneChatDetails.memberLevelName`	`string` Nom du niveau auquel l'utilisateur est membre. Les noms des niveaux sont définis par la chaîne YouTube proposant la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.newSponsorDetails`	`object` cet objet contient des informations sur l'événement "Annonce de nouveau membre". Ce champ n'est défini que si le type est `newSponsorEvent`. "Membre" est le terme utilisé pour "sponsor".
`snippet.newSponsorDetails.memberLevelName`	`string` Nom du niveau auquel l'utilisateur est membre. Les noms des niveaux sont définis par la chaîne YouTube proposant la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.newSponsorDetails.isUpgrade`	`bool` Indique si le spectateur vient de passer d'un niveau infé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 micros de la devise de l'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é. La valeur est un code de devise ISO 4217.
`snippet.superChatDetails.amountDisplayString`	`string` Chaîne, comme `$1.00`, contenant le montant de l'achat et la devise. La chaîne est destinée à être affichée pour l'utilisateur.
`snippet.superChatDetails.userComment`	`string` Commentaire ajouté par l'utilisateur à cet événement Super Chat.
`snippet.superChatDetails.tier`	`unsigned integer` Niveau du 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. 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 flux. Vous trouverez plus d'informations sur les niveaux de Super Chat dans le Centre d'aide YouTube. (voir la section "Informations sur l'achat de Super Chats") Dans cette liste, le niveau correspondant au montant d'achat le plus bas est le niveau 1, le montant suivant est 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` Un ID unique qui identifie l'image de l'autocollant. Notez que l'image ne s'affiche dans le message du super autocollant que lorsque les utilisateurs consultent la fenêtre de chat sur YouTube. Toutefois, l'URL de l'image n'est pas disponible à l'aide de l'API. Pour information uniquement, vous pouvez identifier les ID d'autocollants associés aux super autocollants 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 micros de la devise de l'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é. La valeur est un code de devise ISO 4217.
`snippet.superStickerDetails.amountDisplayString`	`string` Chaîne, comme `$1.00`, contenant le montant de l'achat et la devise. La chaîne est destinée à être affichée pour l'utilisateur.
`snippet.superStickerDetails.tier`	`unsigned integer` Niveau du 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. Il détermine également la couleur utilisée pour mettre en avant 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 flux. Les niveaux de Super Chat, qui couvrent également les Super Stickers, sont décrits dans le Centre d'aide YouTube. (voir la section "Informations sur l'achat de Super Chats") Dans cette liste, le niveau correspondant au montant d'achat le plus bas est le niveau 1, le montant suivant est 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` Détails de l'événement de sondage.
`snippet.pollDetails.metadata.options`	`object` Les options du sondage en direct.
`snippet.pollDetails.metadata.options.optionText`	`string` Texte de l'option de sondage en direct.
`snippet.pollDetails.metadata.options.tally`	`string` Nombre de votes pour l'option de sondage en direct. Le nombre n'est affiché que si la requête API est autorisée par le propriétaire de la chaîne.
`snippet.pollDetails.metadata.questionText`	`string` Texte de la question du sondage en direct.
`snippet.pollDetails.metadata.status`	`enum` Événement de 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 de cadeau d'abonnement. Il n'est présent que si `message type` est `membershipGiftingEvent`.
`snippet.membershipGiftingDetails.giftMembershipsCount`	`integer` Nombre d'abonnements sans frais achetés par l'utilisateur.
`snippet.membershipGiftingDetails.giftMembershipsLevelName`	`string` Nom du niveau des abonnements sans frais achetés par l'utilisateur. Les noms de niveau sont définis par la chaîne YouTube proposant la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.giftMembershipReceivedDetails`	`object` cet objet contient des informations sur un événement "Gift Membership Received" (Abonnement sans frais reçu). Il n'est présent que si `message type` est `giftMembershipReceivedEvent`.
`snippet.giftMembershipReceivedDetails.memberLevelName`	`string` Nom du niveau auquel l'utilisateur est membre. Il correspond à l'`snippet.membershipGiftingDetails.giftMembershipsLevelName` du message de cadeau d'abonnement associé. Les noms de niveau sont définis par la chaîne YouTube proposant la souscription. Dans certains cas, ce champ n'est pas renseigné.
`snippet.giftMembershipReceivedDetails.gifterChannelId`	`string` ID de l'utilisateur qui a acheté l'abonnement sans frais. Il correspond à l'`snippet.authorChannelId` du message de cadeau d'abonnement associé.
`snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId`	`string` ID du message de cadeau d'abonnement associé à cet abonnement sans frais. Cet ID fait toujours référence à un message dont l'`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 est un sponsor du chat en direct.
`authorDetails.isChatModerator`	`boolean` Cette valeur indique si l'auteur est modérateur du chat en direct.