Method: spaces.list

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

Nécessite une authentification. Accepte l'authentification des applications et l'authentification des utilisateurs.

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

Pour répertorier tous les espaces nommés par organisation Google Workspace, utilisez plutôt la méthode spaces.search() avec des droits d'administrateur Workspace.

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 à renvoyer. Le service peut renvoyer moins que cette valeur.

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

La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est 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 de liste précédent d'espaces. Indiquez ce paramètre pour récupérer la page suivante.

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

string

Facultatif. Un filtre de requête.

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 rejetées par le serveur avec une erreur INVALID_ARGUMENT.

Corps de la requête

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

Corps de la réponse

Réponse à une requête d'affichage de la liste des espaces.

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

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

object (Space)

Liste des espaces sur la page demandée (ou la première page).
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, il n'y a pas de pages suivantes.

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 relatif aux autorisations.