Erfordert 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 keine Angabe gemacht wird, werden maximal 100 Leerzeichen zurückgegeben.
Der Höchstwert ist 1.000. Wenn Sie einen höheren Wert als 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 mithilfe der folgenden Parameter suchen:
createTime
customer
displayName
externalUserAllowed
lastActiveTime
spaceHistoryState
spaceType
Für createTime und lastActiveTime ist ein Zeitstempel im RFC-3339-Format zulässig. 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.
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. 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. Die Reihenfolge der Liste 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.
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.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2024-11-08 (UTC)."],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],[]]