- Requête HTTP
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
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 |
Lorsque la valeur est 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 Cette méthode n'est actuellement compatible qu'avec l'accès administrateur. Par conséquent, seul |
pageSize |
Nombre maximal d'espaces à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, au maximum 100 espaces sont renvoyés. La valeur maximale est 1 000. Si vous utilisez une valeur supérieure à 1 000, elle passe automatiquement à 1 000. |
pageToken |
Jeton, reçu lors de l'appel précédent des 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 |
Obligatoire. 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:
|
orderBy |
Facultatif. Comment la liste des espaces est-elle organisée ? Vous pouvez trier les données à l'aide des attributs suivants:
Les valeurs valides pour les opérations de tri sont les suivantes:
La syntaxe prise en charge est la suivante:
|
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[] |
Page des espaces demandés. |
nextPageToken |
Jeton pouvant être utilisé pour récupérer la page suivante. Si ce champ est vide, il n'y a pas de pages suivantes. |
totalSize |
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 relatif aux autorisations.