Method: spaces.search

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 niveau d'accès OAuth 2.0 chat.admin.spaces.readonly ou chat.admin.spaces.

La définition de useAdminAccess sur false est disponible dans la version Preview développeur.

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.

string

Jeton reçu de l'appel précédent de recherche d'espaces. 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.

string

Obligatoire. Requête de recherche.

Vous pouvez effectuer une recherche à l'aide des paramètres suivants lorsque useAdminAccess est défini sur true :

• createTime
• customer
• displayName
• externalUserAllowed
• lastActiveTime
• spaceHistoryState
• spaceType

Lorsque useAdminAccess est défini sur false :

• displayName
• externalUserAllowed

createTime et lastActiveTime acceptent un code temporel au format RFC-3339. Les opérateurs de comparaison compatibles sont les suivants : =, <, >, <=, >=.

customer est obligatoire lorsque useAdminAccess est défini sur true. Il est utilisé pour 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 divisé en jetons. Chaque jeton est ensuite mis en correspondance de manière insensible à 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. Lorsque useAdminAccess est défini sur false, displayName est obligatoire pour récupérer des résultats pertinents. Sinon, le comportement par défaut consiste à renvoyer une réponse vide.

externalUserAllowed accepte true ou false.

spaceHistoryState n'accepte que les valeurs du champ historyState d'une ressource space.

spaceType est obligatoire lorsque useAdminAccess est défini sur true, et la seule valeur valide est SPACE.

Seuls les opérateurs AND sont acceptés dans les différents champs. Un exemple valide est spaceType = "SPACE" AND displayName:"Hello", tandis qu'un exemple non valide est spaceType = "SPACE" OR displayName:"Hello".

Dans le même champ, spaceType n'est pas compatible avec les opérateurs AND ni OR. displayName, `spaceHistoryState` et `externalUserAllowed` ne sont compatibles qu'avec 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, 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 lorsque useAdminAccess est défini sur true :

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")

Les exemples de requêtes suivants sont valides lorsque useAdminAccess est défini sur false :

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

Facultatif. Ordre de la liste des espaces.

Les attributs compatibles 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.

Lorsque useAdminAccess est false, seuls createTime et relevance sont compatibles pour le tri. Seule la valeur DESC est compatible avec ces champs dans les recherches non administratives.

Les valeurs d'opération de tri valides sont les suivantes :

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

• DESC pour l'ordre décroissant.

La syntaxe compatible est la suivante lorsque useAdminAccess est défini sur true :

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

Lorsque useAdminAccess est défini sur false :

• createTime DESC
• relevance DESC

object (Space)

Uniquement en sortie. L'espace correspondant.