Renvoie la liste des espaces d'une organisation Google Workspace en fonction de la recherche d'un administrateur. Dans la requête, définissez useAdminAccess sur true. Pour obtenir un exemple, consultez Rechercher et gérer des espaces.
Cette méthode n'accepte actuellement que l'accès administrateur. Par conséquent, seule la valeur true est acceptée pour ce champ.
pageSize
integer
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 de 1 000. Si vous utilisez une valeur supérieure à 1 000, elle est automatiquement remplacée par 1 000.
pageToken
string
Jeton reçu de l'appel précédent des espaces de recherche. 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 différentes valeurs aux autres paramètres peut entraîner des résultats inattendus.
query
string
Obligatoire. Une requête de recherche.
Vous pouvez effectuer une recherche à l'aide des paramètres suivants :
createTime
customer
displayName
externalUserAllowed
lastActiveTime
spaceHistoryState
spaceType
createTime et lastActiveTime acceptent un code temporel au format RFC-3339. Les opérateurs de comparaison acceptés sont les suivants : =, <, >, <= et >=.
customer est obligatoire et permet d'indiquer le client à partir duquel récupérer les espaces. customers/my_customer est la seule valeur acceptée.
displayName n'accepte que l'opérateur HAS (:). Le texte à faire correspondre est d'abord tokenisé en jetons. Chaque jeton est ensuite mis en correspondance de préfixe de manière indépendante et sans tenir compte de la casse, en tant que sous-chaîne n'importe où dans le displayName de l'espace. Par exemple, Fun Eve correspond à Fun event ou The
evening was fun, mais pas à notFun event ni à even.
externalUserAllowed accepte true ou false.
spaceHistoryState n'accepte que les valeurs du champ historyState d'une ressource space.
spaceType est obligatoire et la seule valeur valide est SPACE.
Seuls les opérateurs AND sont acceptés dans les différents champs. spaceType = "SPACE" AND displayName:"Hello" est un exemple valide, tandis que spaceType = "SPACE" OR displayName:"Hello" ne l'est pas.
Dans un même champ, spaceType n'est pas compatible avec les opérateurs AND ni OR. displayName, "spaceHistoryState" et "externalUserAllowed" n'acceptent que les opérateurs OR. lastActiveTime et createTime acceptent les opérateurs AND et OR. AND ne peut être utilisé que pour représenter un intervalle, tel que lastActiveTime
< "2022-01-01T00:00:00+00:00" AND lastActiveTime >
"2023-01-01T00:00:00+00:00".
Voici des exemples de requêtes valides :
customer = "customers/my_customer" AND spaceType = "SPACE"
customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"
customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")
customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")
customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy
string
Facultatif. Ordre de la liste des espaces.
Les attributs acceptés pour le tri sont les suivants :
membershipCount.joined_direct_human_user_count : indique le nombre d'utilisateurs humains qui ont rejoint directement un espace.
lastActiveTime : indique l'heure à laquelle le dernier élément éligible a été ajouté à un sujet de cet espace.
createTime : indique l'heure de création de l'espace.
Les valeurs d'opération de tri valides sont les suivantes :
Jeton pouvant être utilisé pour récupérer la page suivante. Si ce champ est vide, il n'y a pas d'autres pages.
totalSize
integer
Nombre total d'espaces correspondant à la requête, sur toutes les 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 :
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/20 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/08/20 (UTC)."],[[["\u003cp\u003eReturns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType.\u003c/p\u003e\n"],["\u003cp\u003eRequires administrator privileges and the \u003ccode\u003euseAdminAccess\u003c/code\u003e parameter set to \u003ccode\u003etrue\u003c/code\u003e in the request.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eGET https://chat.googleapis.com/v1/spaces:search\u003c/code\u003e HTTP request with query parameters for customization.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either the \u003ccode\u003echat.admin.spaces\u003c/code\u003e or \u003ccode\u003echat.admin.spaces.readonly\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces.\u003c/p\u003e\n"]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"],null,[]]
