Method: spaces.search

Gibt eine Liste der Gruppenbereiche in einer Google Workspace-Organisation zurück, die auf der Suche eines Administrators basiert.

Erfordert die Authentifizierung von Nutzern mit Administratorberechtigungen und einen der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces

Legen Sie in der Anfrage für useAdminAccess true fest.

HTTP-Anfrage

GET https://chat.googleapis.com/v1/spaces:search

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
useAdminAccess

boolean

Wenn true festgelegt ist, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung Unterhaltungen in Chats und Gruppenbereichen verwalten sein.

Erfordert entweder den OAuth 2.0-Bereichchat.admin.spaces.readonly oder chat.admin.spaces.

Diese Methode unterstützt derzeit nur den Administratorzugriff. Daher ist für dieses Feld nur true zulässig.
pageSize

integer

Die maximale Anzahl der Gruppenbereiche, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Gruppenbereiche 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

string

Ein Token, das vom vorherigen Suchbereichsaufruf 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. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
query

string

Erforderlich. Eine Suchanfrage.

Sie können mit den folgenden Parametern suchen:

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

Für createTime und lastActiveTime ist ein Zeitstempel im RFC-3339 zulässig. Die unterstützten Vergleichsoperatoren sind =, <, >, <= und >=.

customer ist erforderlich und gibt an, von welchem Kunden Gruppenbereiche abgerufen werden sollen. customers/my_customer ist der einzige unterstützte Wert.

Für displayName ist nur der Operator HAS (:) zulässig. Der abzugleichende Text wird zuerst in Token zerlegt. Jedes Token wird dann unabhängig voneinander und ohne Berücksichtigung der Groß- und Kleinschreibung als Substring an einer beliebigen Stelle in der displayName des Gruppenbereichs mit dem Präfix abgeglichen. Beispiel: Fun Eve entspricht Fun event oder The evening was fun, aber nicht notFun event oder even.

Für externalUserAllowed sind entweder true oder false zulässig.

Für spaceHistoryState sind nur Werte aus dem Feld historyState einer space-Ressource zulässig.

spaceType ist erforderlich und der einzige gültige Wert ist SPACE.

Für verschiedene Felder werden nur AND-Operatoren unterstützt. Ein gültiges Beispiel ist spaceType = "SPACE" AND displayName:"Hello" und ein ungültiges Beispiel ist spaceType = "SPACE" OR displayName:"Hello".

Innerhalb desselben Felds werden für spaceType keine AND- oder OR-Operatoren unterstützt. Für displayName, „spaceHistoryState“ und „externalUserAllowed“ werden nur OR-Operatoren unterstützt. lastActiveTime und createTime unterstützen sowohl AND- als auch OR-Operatoren. AND kann nur verwendet werden, um ein Intervall darzustellen, z. B. lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Die folgenden Beispielabfragen sind gültig:

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

Optional. Die Reihenfolge der Gruppenbereiche.

Folgende Attribute werden unterstützt:

  • membershipCount.joined_direct_human_user_count: Gibt die Anzahl der Nutzer an, die einem Gruppenbereich direkt beigetreten sind.
  • lastActiveTime: Gibt an, wann dem letzten Thema in diesem Gruppenbereich ein berechtigtes Element hinzugefügt wurde.
  • createTime – Gibt die Zeit an, zu der der Gruppenbereich erstellt wurde.

Gültige Werte für den Sortiervorgang:

  • ASC für aufsteigend. Standardwert.

  • DESC für absteigend.

Folgende Syntax wird unterstützt:

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

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort mit einer Liste der Gruppenbereiche, die der Anfrage für die Suche nach Gruppenbereichen entsprechen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Felder
spaces[]

object (Space)

Eine Seite der angeforderten Gruppenbereiche.
nextPageToken

string

Ein Token, mit dem die nächste Seite abgerufen werden kann. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.
totalSize

integer

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.