Gibt basierend auf der Suche eines Administrators eine Liste von Gruppenbereichen in einer Google Workspace-Organisation zurück.
Dafür ist eine Nutzerauthentifizierung mit Administratorberechtigungen erforderlich. Legen Sie in der Anfrage useAdminAccess
auf true
fest.
HTTP-Anfrage
GET https://chat.googleapis.com/v1/spaces:search
Die URL verwendet die Syntax der gRPC-Transcodierung.
Abfrageparameter
Parameter | |
---|---|
use |
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 |
page |
Die maximale Anzahl von Leerzeichen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn keine Angabe gemacht wird, werden maximal 100 Leerzeichen zurückgegeben. Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert. |
page |
Ein Token, das vom vorherigen Aufruf von Gruppenbereichen für die Suche empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen. |
query |
Erforderlich. Eine Suchanfrage. Sie können mithilfe der folgenden Parameter suchen:
Für
In verschiedenen Feldern werden nur Innerhalb desselben Felds werden für Die folgenden Beispielabfragen sind gültig:
|
order |
Optional. Die Reihenfolge der Gruppenbereiche. Unterstützte Attribute für die Sortierung sind:
Gültige Werte für den Sortiervorgang:
Folgende Syntax wird unterstützt:
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort mit einer Liste von Gruppenbereichen, die der Anfrage für Gruppenbereiche entsprechen.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"spaces": [
{
object ( |
Felder | |
---|---|
spaces[] |
Eine Seite der angeforderten Gruppenbereiche. |
next |
Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten. |
total |
Die Gesamtzahl der Gruppenbereiche, die der Suchanfrage entsprechen, auf allen Seiten. Wenn das Ergebnis mehr als 10.000 Plätze beträgt, 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 Leitfaden zur Autorisierung.