Method: spaces.messages.list

Répertorie les messages d'un espace dont l'appelant est membre, y compris les messages des membres et espaces bloqués. Pour obtenir un exemple, consultez Répertorier les messages. Nécessite l'authentification de l'utilisateur.

Requête HTTP :

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'espace à partir duquel répertorier les messages.

Format : spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de messages renvoyés. Le service peut renvoyer moins de messages que cette valeur.

Si aucune valeur n'est spécifiée, la valeur maximale est renvoyée : 25.

La valeur maximale est de 1 000. Si vous utilisez une valeur supérieure à 1 000, elle sera automatiquement remplacée par 1 000.

Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

Facultatif, si vous réactivez une requête précédente.

Jeton de page reçu d'un appel de messages de liste précédent. Indiquez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. La transmission de valeurs différentes aux autres paramètres peut entraîner des résultats inattendus.
filter

string

Filtre de requête.

Vous pouvez filtrer les messages par date (createTime) et par fil de discussion (thread.name).

Pour filtrer les messages en fonction de leur date de création, spécifiez le createTime avec un horodatage au format RFC-3339 et des guillemets. Exemple : "2023-04-21T11:30:00-04:00". Vous pouvez utiliser l'opérateur supérieur > pour lister les messages créés après un horodatage, ou l'opérateur inférieur à < pour lister les messages créés avant un horodatage donné. Pour filtrer les messages dans un intervalle de temps donné, utilisez l'opérateur AND entre deux horodatages.

Pour filtrer par thread, spécifiez thread.name, au format spaces/{space}/threads/{thread}. Vous ne pouvez spécifier qu'une seule thread.name par requête.

Pour filtrer par thread et par date, utilisez l'opérateur AND dans votre requête.

Par exemple, les requêtes suivantes sont valides:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Les requêtes non valides sont refusées par le serveur avec une erreur INVALID_ARGUMENT.
orderBy

string

Facultatif, si vous réactivez une requête précédente.

Comment les messages sont classés dans la liste. Spécifiez une valeur à trier par opération de tri. Les valeurs valides pour les opérations de tri sont les suivantes:

  • ASC pour l'ordre croissant.

  • DESC pour l'ordre décroissant.

Le tri par défaut est createTime ASC.
showDeleted

boolean

Permet d'inclure ou non les messages supprimés. Les messages supprimés comprennent l'heure de suppression et les métadonnées concernant leur suppression, mais leur contenu n'est pas disponible.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Champs
messages[]

object (Message)

Liste de messages.
nextPageToken

string

Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, aucune page suivante n'existe.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Pour en savoir plus, consultez le guide sur les autorisations.