- Requête HTTP
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Renvoie la liste des espaces d'une organisation Google Workspace en fonction de la recherche d'un administrateur.
Nécessite une authentification des utilisateurs avec des droits d'administrateur. Dans la requête, définissez useAdminAccess
sur true
.
Requête HTTP
GET https://chat.googleapis.com/v1/spaces:search
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de requête
Paramètres | |
---|---|
use |
Lorsque la valeur est L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit de gérer les conversations Chat et Espaces. Nécessite le champ d'application OAuth 2.0 Actuellement, cette méthode n'accepte que l'accès administrateur. Par conséquent, seul |
page |
Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à 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. |
page |
Jeton reçu lors de l'appel d'espaces de recherche précédent. Fournissez 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. Transmettre des valeurs différentes aux autres paramètres peut entraîner des résultats inattendus. |
query |
Obligatoire. Une requête de recherche Vous pouvez effectuer une recherche à l'aide des paramètres suivants:
Dans les différents champs, seuls les opérateurs Dans le même champ, Les exemples de requêtes suivants sont valides:
|
order |
Facultatif. Ordre de la liste des espaces. Les attributs acceptés pour la commande sont les suivants :
Les valeurs d'opération d'ordonnancement valides sont les suivantes :
Les syntaxes acceptées sont les suivantes :
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse avec une liste d'espaces correspondant à la requête d'espaces de recherche.
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[] |
Une page des espaces demandés. |
next |
Jeton permettant de récupérer la page suivante. Si ce champ est vide, aucune page suivante n'existe. |
total |
Nombre total d'espaces correspondant à la requête, sur l'ensemble des pages. Si le résultat est supérieur à 10 000 espaces, cette valeur est une estimation. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
Pour en savoir plus, consultez le guide d'autorisation.