Method: spaces.search

Renvoie une liste d'espaces en fonction de la recherche d'un utilisateur. Nécessite une authentification de l'utilisateur. L'utilisateur doit être administrateur de l'organisation Google Workspace. 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 avec les droits d'administrateur Google Workspace de l'utilisateur.

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 chat.admin.spaces.readonly ou chat.admin.spaces.

Actuellement, cette méthode n'accepte que 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 précédent dans les espaces de recherche. Indiquez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page. La transmission de valeurs différentes 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 compatibles sont: =, <, >, <=, >=.

customer est obligatoire et permet d'indiquer le client à partir duquel extraire les espaces. customers/my_customer est la seule valeur acceptée.

displayName n'accepte que l'opérateur HAS (:). Le texte à mettre en correspondance est d'abord tokenisé en jetons, et chaque jeton est mis en correspondance sans tenir compte de la casse et indépendamment 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. 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. spaceType = "SPACE" OR displayName:"Hello" est un exemple non valide.

Parmi 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 sont compatibles avec les opérateurs AND et OR. AND ne peut être utilisé que pour représenter un intervalle, par exemple 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. Façon dont la liste des espaces est organisée.

Les attributs acceptés pour trier par sont les suivants:

  • membershipCount.joined_direct_human_user_count : indique le nombre d'utilisateurs humains qui ont directement rejoint 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 valides pour les opérations de tri sont les suivantes:

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

  • DESC pour l'ordre décroissant.

La syntaxe acceptée est la suivante:

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

object (Space)

Une page des espaces demandés.
nextPageToken

string

Jeton permettant de récupérer la page suivante. Si ce champ est vide, il n'y a pas de pages suivantes.
totalSize

integer

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