- Requête HTTP
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Répertorie 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'est pas envoyé. Pour obtenir un exemple, consultez la section Répertorier les espaces.
Une authentification est requise. Il prend en charge 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 répertoriés tant que le premier message n'est pas envoyé.
Pour répertorier tous les espaces nommés par organisation Google Workspace, utilisez la méthode spaces.search()
en utilisant les 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 |
Facultatif. Nombre maximal d'espaces à renvoyer. Le service peut renvoyer une valeur inférieure à cette valeur. Si aucune valeur n'est spécifiée, au maximum 100 espaces sont renvoyés. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle passe automatiquement à 1 000. Les valeurs négatives renvoient une erreur |
pageToken |
Facultatif. Jeton de page, reçu lors d'un précédent appel d'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 qui a fourni le jeton de page. La transmission d'une valeur différente peut entraîner des résultats inattendus. |
filter |
Facultatif. Un filtre de requête. Vous pouvez filtrer les espaces par type ( Pour filtrer par type d'espace, vous devez spécifier une valeur d'énumération valide, telle que Par exemple, les requêtes suivantes sont valides:
Les requêtes non valides sont rejetées par le serveur avec une erreur |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse à une requête de liste d'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 ( |
Champs | |
---|---|
spaces[] |
Liste des espaces sur la page demandée (ou la première). |
nextPageToken |
Vous pouvez envoyer un jeton en tant que |
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.