Method: spaces.search

Gibt basierend auf der Suche eines Nutzers eine Liste von Gruppenbereichen zurück. Erfordert eine Nutzerauthentifizierung. Der Nutzer muss ein Administrator für die Google Workspace-Organisation sein. Legen Sie in der Anfrage für useAdminAccess den Wert 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, 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 den OAuth 2.0-Bereich chat.admin.spaces.readonly oder chat.admin.spaces.

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

integer

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

Wenn keine Vorgabe erfolgt, werden maximal 100 Leerzeichen zurückgegeben.

Der Maximalwert beträgt 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 des Suchbereichs empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren sollten alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe verschiedener Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
query

string

Erforderlich. Eine Suchanfrage.

Für die Suche können die folgenden Parameter verwendet werden: – createTime – customer – displayName – externalUserAllowed – lastActiveTime – spaceHistoryState – spaceType

createTime und lastActiveTime akzeptieren einen Zeitstempel im RFC-3339-Format. 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.

displayName akzeptiert nur den Operator HAS (:). Der abzugleichende Text wird zuerst in Tokens tokenisiert. Jedes Token wird unabhängig von Groß- und Kleinschreibung als Teilstring im displayName des Gruppenbereichs abgeglichen. Dabei spielt die Groß- und Kleinschreibung keine Rolle. Beispiel: Fun Eve stimmt mit Fun event oder The evening was fun überein, aber nicht mit 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.

In den verschiedenen Feldern 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".

Unter demselben Feld werden die Operatoren AND und OR von spaceType nicht unterstützt. displayName, „spacehistoryState“ und „externalUserAllowed“ unterstützen nur OR-Operatoren. lastActiveTime und createTime unterstützen die Operatoren AND und OR. AND kann nur zur Darstellung eines Intervalls verwendet werden, 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 für die Sortierung unterstützt:

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

Gültige Werte für Sortiervorgänge 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 der Anfrage für Gruppenbereiche entsprechen.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

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

object (Space)

Eine Seite mit den angeforderten Gruppenbereichen.
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 Leerzeichen, die der Abfrage entsprechen, auf allen Seiten. 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 Leitfaden zur Autorisierung.