Gibt eine Liste von Bereichen in einer Google Workspace-Organisation basierend auf der Suche eines Administrators zurück. Legen Sie in der Anfrage für useAdminAccess
true
fest. Ein Beispiel finden Sie unter Projektbereiche suchen und verwalten.
Erfordert Nutzerauthentifizierung mit Administratorberechtigungen und einen der folgenden Autorisierungsbereiche:
https://www.googleapis.com/auth/chat.admin.spaces.readonly
https://www.googleapis.com/auth/chat.admin.spaces
HTTP-Anfrage
GET https://chat.googleapis.com/v1/spaces:search
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
Parameter | |
---|---|
useAdminAccess |
Wenn Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein. Erfordert den OAuth 2.0-Bereich Diese Methode unterstützt derzeit nur Administratorzugriff. Daher wird für dieses Feld nur |
pageSize |
Die maximale Anzahl der zurückzugebenden Arbeitsbereiche. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Bereiche zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. |
pageToken |
Ein Token, das vom vorherigen Aufruf von Suchbereichen empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen. Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen. |
query |
Erforderlich. Eine Suchanfrage. Sie können mit den folgenden Parametern suchen:
Für
Für verschiedene Felder werden nur Im selben Feld werden die Operatoren Die folgenden Beispielabfragen sind gültig:
|
orderBy |
Optional. So wird die Liste der Gruppenbereiche sortiert. Folgende Attribute können für die Sortierung verwendet werden:
Gültige Werte für den Sortiervorgang sind:
Folgende Syntax wird unterstützt:
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort mit einer Liste von Gruppenbereichen, die dem Request für Suchbereiche entsprechen.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"spaces": [
{
object ( |
Felder | |
---|---|
spaces[] |
Eine Seite der angeforderten Gruppenbereiche. |
nextPageToken |
Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten. |
totalSize |
Die Gesamtzahl der Bereiche, die der Abfrage entsprechen, über alle Seiten hinweg. Wenn das Ergebnis mehr als 10.000 Leerzeichen umfasst, ist dieser Wert eine Schätzung. |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
Weitere Informationen finden Sie im Autorisierungsleitfaden.