Method: spaces.search

Renvoie la liste des espaces d'une organisation Google Workspace en fonction de la recherche d'un administrateur.

Nécessite l'authentification de l'utilisateur avec des droits d'administrateur et l'un des champs d'application d'autorisation suivants:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces

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
useAdminAccess

boolean

Lorsque la valeur est true, la méthode s'exécute à l'aide des droits d'administrateur Google Workspace de l'utilisateur.

L'utilisateur appelant doit être un administrateur Google Workspace disposant du droit Gérer les conversations Chat et Espaces.

Nécessite le champ d'application OAuth 2.0 chat.admin.spaces.readonly ou chat.admin.spaces.

Cette méthode n'est actuellement compatible qu'avec l'accès administrateur. Par conséquent, seul true est accepté 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 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 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

string

Obligatoire. 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 les espaces doivent être récupérés. 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, et chaque jeton est mis en correspondance avec un préfixe, sans distinction de casse et indépendamment, en tant que sous-chaîne n'importe où dans l'displayName de l'espace. Par exemple, Fun Eve correspond à Fun event ou The evening was fun, mais pas à notFun event ou 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.

Dans les différents champs, seuls les opérateurs AND sont acceptés. spaceType = "SPACE" AND displayName:"Hello" est un exemple valide, tandis que spaceType = "SPACE" OR displayName:"Hello" est un exemple non valide.

Dans le même champ, spaceType n'est pas compatible avec les opérateurs AND ou 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".

Les exemples de requêtes suivants sont 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 ayant 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 d'ordonnancement valides sont les suivantes:

  • ASC pour l'ordre croissant. Valeur par défaut.

  • DESC pour décroissant.

Les syntaxes acceptées sont les suivantes:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

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 de recherche 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 (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Champs
spaces[]

object (Space)

Page des espaces demandés.
nextPageToken

string

Jeton permettant de récupérer la page suivante. Si ce champ est vide, aucune page suivante n'existe.
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 :

  • 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.