Method: spaces.search

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

pageToken

string

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

string

Erforderlich. Eine Suchanfrage.

Sie können mithilfe der folgenden Parameter suchen:

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

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

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 Token zerlegt und jedes Token wird unabhängig voneinander und ohne Berücksichtigung der Groß- und Kleinschreibung als Substring an einer beliebigen Stelle in der displayName des Gruppenbereichs mit einem Präfix abgeglichen. Beispiel: Fun Eve entspricht Fun event oder The evening was fun, aber nicht notFun event oder even.

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

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 wie lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00" darzustellen.

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.

Unterstützte Attribute für die Sortierung sind:

  • 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 zu einem Thema dieses Gruppenbereichs hinzugefügt wurde.
  • createTime: Gibt den Zeitpunkt der Erstellung des Gruppenbereichs an.

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 von Gruppenbereichen, die der Anfrage für Gruppenbereiche 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.