LiveChatMessages: list

Remarque : Pour interroger les messages de chat en direct, utilisez la méthode liveChatMessages.streamList. La méthode streamList envoie de nouveaux messages au client dès qu'ils sont disponibles, ce qui réduit le besoin d'interrogation constante et permet d'éviter de dépasser votre quota.

Liste les messages de chat en direct pour un chat spécifique.

Lorsque vous effectuez votre première requête pour récupérer les messages de chat, l'API renvoie tout ou partie de l'historique des discussions, en fonction de sa longueur. Les messages de la réponse sont classés du plus ancien au plus récent.

• Le nextPageToken de la réponse fournit un jeton qui, dans votre prochaine requête, identifiera l'ensemble de résultats suivant que votre client API doit récupérer.
• La propriété pollingIntervalMillis indique la durée pendant laquelle votre client API doit attendre avant de demander des résultats supplémentaires.

Lorsque vous demandez des résultats supplémentaires, vous définissez le paramètre pageToken sur la valeur nextPageToken, et le serveur API renvoie des messages de chat supplémentaires, le cas échéant. Là encore, dans cet ensemble de résultats, les messages sont classés du plus ancien au plus récent.

Impact sur le quota : un appel à cette méthode a un coût de quota de 5 unités.

Cas d'utilisation courants

Requête

Requête HTTP

GET https://www.googleapis.com/youtube/v3/liveChat/messages

Paramètres

Le tableau suivant répertorie les paramètres compatibles avec cette requête. Tous les paramètres listés sont des paramètres de requête.

Paramètres
Paramètres obligatoires
liveChatId	string Le paramètre liveChatId spécifie l'ID du chat dont les messages seront renvoyés. L'ID du chat en direct associé à une diffusion est renvoyé dans la propriété snippet.liveChatId de la ressource liveBroadcast.
part	string Le paramètre part spécifie les parties de la ressource liveChatMessage que la réponse de l'API inclura. Les valeurs acceptées sont id, snippet et authorDetails.
Paramètres facultatifs
hl	string Le paramètre hl demande à l'API de récupérer une chaîne d'affichage de devise localisée pour une langue d'application spécifique compatible avec le site Web YouTube. Par exemple, en anglais, la devise s'affiche sous la forme $1.50, mais en français, elle s'affiche sous la forme 1,50$. La valeur du paramètre doit être un code de langue inclus dans la liste renvoyée par la méthode i18nLanguages.list.
maxResults	unsigned integer Le paramètre maxResults spécifie le nombre maximal de messages à renvoyer dans l'ensemble de résultats. Les valeurs acceptables sont comprises entre 200 et 2000 inclus. La valeur par défaut est 500. La requête initiale effectuée sans jeton de continuation ne contient que les messages les plus récents. Cette valeur peut être inférieure à maxResults, si elle est fournie. L'API ne récupère pas les messages plus anciens que ceux renvoyés par la requête initiale effectuée sans jeton de continuation.
pageToken	string Le paramètre pageToken identifie une page spécifique de l'ensemble de résultats à renvoyer. Dans une réponse de l'API, la propriété nextPageToken identifie d'autres pages qui pourraient être récupérées.
profileImageSize	unsigned integer Le paramètre profileImageSize spécifie la taille des photos de profil utilisateur à renvoyer dans l'ensemble de résultats. Les images sont carrées. La valeur par défaut est 88, ce qui signifie que les images seront de 88 x 88 pixels. Les valeurs acceptables sont comprises entre 16 et 720 inclus.

Corps de la requête

Ne fournissez pas de corps de requête lorsque vous appelez cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "youtube#liveChatMessageListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pollingIntervalMillis": unsigned integer,
  "offlineAt": datetime,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatMessage Resource
  ],
  "activePollItem": liveChatMessage Resource
}

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#liveChatMessageListResponse.
etag	etag L'Etag de cette ressource.
nextPageToken	string Le jeton qui peut être utilisé comme valeur du paramètre pageToken pour récupérer la page suivante dans l'ensemble de résultats.
pollingIntervalMillis	unsigned integer Durée, en millisecondes, pendant laquelle le client doit attendre avant d'interroger à nouveau les nouveaux messages de chat en direct.
offlineAt	datetime Date et heure auxquelles la diffusion en direct sous-jacente a été mise hors ligne. Cette propriété n'est présente que si la diffusion est déjà hors ligne. La valeur est spécifiée au format ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
pageInfo	object L'objet pageInfo encapsule les informations de pagination pour l'ensemble de résultats.
pageInfo.totalResults	integer Nombre total de résultats dans l'ensemble de résultats.
pageInfo.resultsPerPage	integer Nombre de résultats inclus dans la réponse de l'API.
items[]	list Liste de messages. Chaque élément de la liste est une ressource liveChatMessage.
activePollItem	object Les données du sondage dans le message. Chaque sondage est une ressource liveChatMessage de type pollEvent, qui représente un sondage actif. Il ne peut y avoir qu'un seul sondage par chat.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel à cette méthode. Pour en savoir plus, consultez la documentation sur les messages d'erreur.

Type d'erreur	Détails de l'erreur	Description
forbidden (403)	forbidden	Vous ne disposez pas des autorisations requises pour récupérer les messages du chat en direct spécifié.
forbidden (403)	liveChatDisabled	Le chat en direct n'est pas activé pour la diffusion spécifiée.
forbidden (403)	liveChatEnded	Le chat en direct spécifié n'est plus en direct.
notFound (404)	liveChatNotFound	Le chat en direct que vous essayez de récupérer est introuvable. Vérifiez la valeur du paramètre liveChatId de la requête pour vous assurer qu'elle est correcte.
rateLimitExceeded	rateLimitExceeded	La requête a été envoyée trop rapidement après la requête précédente. Cette erreur se produit lorsque les requêtes API visant à récupérer des messages sont envoyées plus fréquemment que les fréquences d'actualisation de YouTube, ce qui gaspille inutilement de la bande passante.

Essayer

Utilisez l'APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.