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

LiveChatMessages: list

Liste les messages d'un chat spécifique.

Lorsque vous effectuez votre première requête de récupération des messages, l'API renvoie une partie ou l'intégralité de l'historique des discussions, en fonction de la longueur de cet historique. Les messages de la réponse sont triés du plus ancien au plus récent.

Le nextPageToken de la réponse fournit un jeton qui, dans votre prochaine requête, identifiera le prochain ensemble de résultats que votre client API devra récupérer.
La propriété pollingIntervalMillis indique le temps que 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. Le serveur d'API renvoie alors des messages de chat supplémentaires, s'ils sont disponibles. Dans cet ensemble de résultats, les messages sont classés du plus ancien au plus récent.

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 répertorié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 de 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` qui seront incluses dans la réponse de l'API. 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 serait affichée sous la forme `$1.50`, mais en français, elle serait affichée 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 autorisées vont de `200` à `2000`, inclus. La valeur par défaut est `500`.
`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 peuvent ê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 mesurent 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
  ]
}

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#liveChatMessageListResponse`.
`etag`	`etag` Etag de cette ressource.
`nextPageToken`	`string` Jeton pouvant ê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 du chat en direct.
`offlineAt`	`datetime` Date et heure de la déconnexion du flux en direct sous-jacent. Cette propriété n'est présente que si le flux est déjà hors connexion. 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 des messages du chat en direct. Chaque élément de la liste est une ressource `liveChatMessage`.

Erreurs

Le tableau suivant identifie les messages d'erreur que l'API peut renvoyer en réponse à un appel de 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 nécessaires 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 que la valeur du paramètre `liveChatId` de la requête 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 pour récupérer les 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 APIs Explorer pour appeler cette API et afficher la requête et la réponse de l'API.