Method: spaces.search

boolean

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

Der aufrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung zum Verwalten von Unterhaltungen in Chats und Gruppenbereichen sein.

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

Die Einstellung useAdminAccess auf false ist in der Entwicklervorschau verfügbar.

integer

Die maximale Anzahl der zurückzugebenden Gruppenbereiche. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Gruppenbereiche zurückgegeben.

Der Maximalwert ist 1000. Wenn Sie einen Wert über 1000 verwenden, wird er automatisch auf 1000 geändert.

string

Ein Token, das vom vorherigen Aufruf zum Suchen von Gruppenbereichen 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 dies zu unerwarteten Ergebnissen führen.

string

Erforderlich. Eine Suchanfrage.

Sie können mit den folgenden Parametern suchen, wenn useAdminAccess auf true gesetzt ist:

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

Wenn useAdminAccess auf false gesetzt ist:

• displayName
• externalUserAllowed

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

customer ist erforderlich, wenn useAdminAccess auf true gesetzt ist. Er 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 Tokens zerlegt. Jedes Token wird unabhängig und ohne Berücksichtigung der Groß-/Kleinschreibung als Teilstring an einer beliebigen Stelle im displayName des Gruppenbereichs mit einem Präfix abgeglichen. Beispiel: Fun Eve stimmt mit Fun event oder The evening was fun überein, aber nicht mit notFun event oder even. Wenn useAdminAccess auf false gesetzt ist, ist displayName erforderlich, um aussagekräftige Ergebnisse abzurufen. Andernfalls wird standardmäßig eine leere Antwort zurückgegeben.

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

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

spaceType ist erforderlich, wenn useAdminAccess auf true gesetzt ist. 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". Ein ungültiges Beispiel ist spaceType = "SPACE" OR displayName:"Hello".

Für dasselbe Feld werden für spaceType keine AND- oder OR-Operatoren unterstützt. Für displayName, `spaceHistoryState` und `externalUserAllowed` werden nur OR-Operatoren unterstützt. Für lastActiveTime und createTime werden sowohl AND- als auch OR-Operatoren unterstützt. 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, wenn useAdminAccess auf true gesetzt ist:

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

Die folgenden Beispielabfragen sind gültig, wenn useAdminAccess auf false gesetzt ist:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

Optional. Wie die Liste der Gruppenbereiche sortiert wird.

Unterstützte Attribute für die Sortierung sind:

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

Wenn useAdminAccess auf false gesetzt ist, werden nur createTime und relevance für die Sortierung unterstützt. Für diese Felder wird bei nicht administrativen Suchanfragen nur DESC unterstützt.

Gültige Werte für den Sortiervorgang sind:

• ASC für aufsteigend. Standardwert.

• DESC für absteigend.

Die unterstützte Syntax, wenn useAdminAccess auf true gesetzt ist:

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

Wenn useAdminAccess auf false gesetzt ist:

• createTime DESC
• relevance DESC

object (Space)

Nur Ausgabe. Der übereinstimmende Gruppenbereich.