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é.
La fonctionnalité de chat en direct est activée par défaut pour les diffusions en direct et est disponible pendant l'événement en direct. (Une fois l'événement terminé, le chat en direct n'est plus disponible pour cet événement.)
Méthodes
L'API accepte les méthodes suivantes pour les ressources liveChatMessages
:
- liste
- Liste les messages du chat en direct pour un chat spécifique. Essayer
- insérer
- Ajoute un message ou un sondage à un chat en direct. Essayer
- transition
- Fait passer un message en direct à un autre état. 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
- streamList
- Active une connexion de streaming serveur pour recevoir les messages du chat en direct d'un chat spécifique avec une faible latence. 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 ressource de l'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 des informations de base 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 :
|
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 qui a créé le message. Ce champ n'est rempli que pour les types de messages suivants :
|
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 du contenu à afficher aux utilisateurs. |
snippet.displayMessage |
string Contient une chaîne affiché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 sont obsolètes. 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 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é a été abandonnée. Devise dans laquelle le financement a été effectué. |
snippet.fanFundingEventDetails.amountDisplayString |
string Remarque : Cette propriété a été abandonnée. Chaîne affichée qui indique le montant et la devise du fonds à l'utilisateur. |
snippet.fanFundingEventDetails.userComment |
string Remarque : Cette propriété a été abandonnée. Commentaire ajouté par l'utilisateur à cet événement de financement participatif. |
snippet.textMessageDetails |
object Cet objet contient des informations sur le message. 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 du 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 à la valeur de la propriété id du message texte d'origine. Par exemple, si un textMessageEvent a une valeur de propriété id de 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. Il contient également des informations sur l'exclusion elle-même. Les utilisateurs peuvent être bannis d'un chat de manière permanente ou temporaire. |
snippet.userBannedDetails.bannedUserDetails |
object Cet objet contient des informations sur l'utilisateur banni. |
snippet.userBannedDetails.bannedUserDetails.channelId |
string ID de 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 banni. |
snippet.userBannedDetails.bannedUserDetails.profileImageUrl |
string Avatar de la chaîne YouTube de l'utilisateur exclu. |
snippet.userBannedDetails.banType |
string Type de suspension. Les valeurs valides pour cette propriété sont les suivantes :
|
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 à 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 au supérieur) pendant lesquels le spectateur a été membre et qui lui ont permis de bénéficier de ce chat de fidélité. Il s'agit du même nombre de mois que celui affiché aux utilisateurs YouTube. |
snippet.memberMilestoneChatDetails.memberLevelName |
string Nom du niveau auquel le spectateur est membre. Les noms de niveau sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas rempli. |
snippet.newSponsorDetails |
object Cet objet contient des informations sur l'événement "Annonce d'un nouveau membre". Ce champ n'est défini que si le type est newSponsorEvent . Le terme "membre" désigne un "sponsor".
|
snippet.newSponsorDetails.memberLevelName |
string Nom du niveau auquel le spectateur est membre. Les noms de niveau sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas rempli. |
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 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 et la devise de l'achat. Cette 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 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é au ticker. Les niveaux de Super Chat sont décrits dans le Centre d'aide YouTube. (Consultez la section développable sur les informations concernant l'achat de Super Chats.) Dans cette liste, le niveau avec le montant d'achat le plus bas est le niveau 1, le niveau 2 correspond au montant suivant le plus bas, 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 Détails sur le Super Sticker. |
snippet.superStickerDetails.superStickerMetadata.stickerId |
string ID unique qui identifie l'image de l'autocollant. Notez que l'image ne s'affiche que dans le message Super Autocollant 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 trouverez les ID des 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 micro-unités 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 et la devise de l'achat. Cette 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 évidence 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é au ticker. Les niveaux de Super Chat, qui couvrent également les Super Stickers, sont décrits dans le Centre d'aide YouTube. (Consultez la section développable sur les informations concernant l'achat de Super Chats.) Dans cette liste, le niveau avec le montant d'achat le plus bas est le niveau 1, le niveau 2 correspond au montant suivant le plus bas, 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 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 du sondage en direct. |
snippet.pollDetails.metadata.options.tally |
string Nombre de votes pour l'option du sondage en direct. Le décompte n'est présent que si la demande d'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 État de l'événement de sondage en direct. Les valeurs valides pour cette propriété sont les suivantes :
|
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 offerts par l'utilisateur. |
snippet.membershipGiftingDetails.giftMembershipsLevelName |
string Nom du niveau des souscriptions en cadeau achetées par l'utilisateur. Les noms de niveau sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas rempli. |
snippet.giftMembershipReceivedDetails |
object Cet objet contient des informations sur un événement "Cadeau d'abonnement reçu". Il n'est présent que si message type est giftMembershipReceivedEvent . |
snippet.giftMembershipReceivedDetails.memberLevelName |
string Nom du niveau auquel le spectateur est membre. Cela correspond au snippet.membershipGiftingDetails.giftMembershipsLevelName du message associé à l'offre d'abonnement en cadeau. Les noms de niveau sont définis par la chaîne YouTube qui propose la souscription. Dans certains cas, ce champ n'est pas rempli. |
snippet.giftMembershipReceivedDetails.gifterChannelId |
string ID de l'utilisateur qui a effectué l'achat de l'abonnement à offrir. Cela correspond au snippet.authorChannelId du message associé à l'offre de cadeau d'abonnement. |
snippet.giftMembershipReceivedDetails.associatedMembershipGiftingMessageId |
string ID du message de cadeau d'abonnement associé à cet abonnement sans frais. Cet ID fera toujours référence à un message dont le type est membershipGiftingEvent . |
authorDetails |
object L'objet authorDetails contient des informations supplémentaires sur l'utilisateur qui a posté 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 un modérateur du chat en direct. |