Method: spaces.list

Liste les espaces dont l'appelant est membre. Les chats de groupe et les MP ne sont pas répertoriés tant que le premier message n'a pas été envoyé. Pour obtenir un exemple, consultez Répertorier les espaces.

Nécessite une authentification. Entièrement compatible avec l'authentification du compte de service, et l'authentification des utilisateurs nécessite le champ d'application des autorisations chat.spaces ou chat.spaces.readonly.

Liste les espaces visibles par l'appelant ou l'utilisateur authentifié. Les chats de groupe et les MP ne sont pas répertoriés tant que le premier message n'a pas été envoyé.

Requête HTTP :

GET https://chat.googleapis.com/v1/spaces

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal d'espaces à afficher. Le service peut renvoyer une valeur inférieure à cette valeur.

Si aucune valeur n'est spécifiée, un maximum de 100 espaces sont renvoyés.

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. Jeton de page reçu d'un appel précédent des espaces de liste. Indiquez ce paramètre pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. La transmission d'une valeur différente peut entraîner des résultats inattendus.
filter

string

Facultatif. Filtre de requête.

Nécessite l'authentification de l'utilisateur.

Vous pouvez filtrer les espaces par type (spaceType).

Pour filtrer par type d'espace, vous devez spécifier une valeur d'énumération valide, telle que SPACE ou GROUP_CHAT (spaceType ne peut pas être SPACE_TYPE_UNSPECIFIED). Pour interroger plusieurs types d'espaces, utilisez l'opérateur OR.

Par exemple, les requêtes suivantes sont valides:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

Avec l'authentification du compte de service, ce champ est ignoré et la requête renvoie toujours tous les espaces. Cependant, l'API Chat valide toujours la syntaxe des requêtes avec les comptes de service, de sorte que les requêtes non valides sont toujours refusées.

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 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Champs
spaces[]

object (Space)

Liste des espaces sur la (ou la première) page demandée.
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.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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