Method: spaces.search

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

boolean

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

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

Erfordert den OAuth 2.0-Bereich chat.admin.spaces.readonly oder chat.admin.spaces.

Diese Methode unterstützt derzeit nur Administratorzugriff. Daher wird für dieses Feld nur true akzeptiert.

pageSize

integer

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

string

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

string

Erforderlich. Eine Suchanfrage.

Sie können mit den folgenden Parametern suchen:

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

createTime und lastActiveTime akzeptieren einen Zeitstempel im RFC-3339. Die unterstützten Vergleichsoperatoren sind: =, <, >, <=, >=.

customer ist erforderlich und wird verwendet, um anzugeben, 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 Tokens zerlegt. Jedes Token wird dann unabhängig und ohne Berücksichtigung der Groß- und Kleinschreibung als Teilstring an einer beliebigen Stelle in der displayName des Bereichs mit einem Präfix abgeglichen. Beispiel: Fun Eve entspricht Fun event oder The evening was fun, aber nicht notFun event oder even.

externalUserAllowed akzeptiert entweder true oder false.

spaceHistoryState akzeptiert nur Werte aus dem Feld historyState einer space-Ressource.

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

Im selben Feld werden die Operatoren AND oder OR nicht unterstützt.spaceType displayName, „spaceHistoryState“ und „externalUserAllowed“ unterstützen nur OR-Operatoren. 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. So wird die Liste der Gruppenbereiche sortiert.

Folgende Attribute können für die Sortierung verwendet werden:

  • membershipCount.joined_direct_human_user_count: Anzahl der Nutzer, die einem Gruppenbereich direkt beigetreten sind.
  • lastActiveTime: Gibt den Zeitpunkt an, zu dem das letzte zulässige Element einem Thema dieses Bereichs hinzugefügt wurde.
  • createTime: Gibt die Uhrzeit an, zu der der Bereich erstellt wurde.

Gültige Werte für den Sortiervorgang sind:

  • 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 von Gruppenbereichen, die dem Request für Suchbereiche 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 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.