Method: spaces.findGroupChats

Gibt alle Bereiche mit spaceType == GROUP_CHAT zurück, deren Mitgliedschaften genau den aufrufenden Nutzer und die in FindGroupChatsRequest.users angegebenen Nutzer enthalten. Es werden nur Mitglieder unterstützt, die der Unterhaltung beigetreten sind. Ein Beispiel finden Sie unter Gruppenchats suchen.

Wenn der aufrufende Nutzer einige Nutzer blockiert oder von einigen Nutzern blockiert wird und keine Bereiche mit der gesamten angegebenen Gruppe von Nutzern gefunden werden, gibt diese Methode Bereiche zurück, die die blockierten oder blockierenden Nutzer nicht enthalten.

Die angegebene Gruppe von Nutzern darf nur Mitgliedschaften von Personen (nicht von Apps) enthalten. Eine Anfrage, die nicht menschliche Nutzer enthält, gibt keine Bereiche zurück.

Erfordert eine Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

HTTP-Anfrage

GET https://chat.googleapis.com/v1/spaces:findGroupChats

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
users[]

string

Optional. Ressourcennamen aller menschlichen Nutzer im Gruppenchat mit dem aufrufenden Nutzer. Chat-Apps können nicht in die Anfrage aufgenommen werden.

Die maximale Anzahl von Nutzern, die in einer einzelnen Anfrage angegeben werden können, beträgt 49.

Format: users/{user}, wobei {user} entweder die id für die Person aus der People API oder die id für den Nutzer in der Directory API ist. Wenn Sie beispielsweise alle Gruppenchats mit dem aufrufenden Nutzer und zwei anderen Nutzern mit den People API-Profil-IDs 123456789 und 987654321 finden möchten, können Sie users/123456789 und users/987654321 verwenden. Sie können die E-Mail-Adresse auch als Alias für {user} verwenden. Beispiel: users/example@gmail.com, wobei example@gmail.com die E-Mail-Adresse des Google Chat-Nutzers ist.

pageSize

integer

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

Wenn nicht angegeben, werden maximal 10 Bereiche zurückgegeben.

Der Höchstwert sind 30 Tage. Wenn Sie einen Wert über 30 verwenden, wird er automatisch auf 30 geändert.

Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.

pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Suchen von Gruppenchats 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 Token bereitgestellt hat. Die Übergabe anderer Werte kann zu unerwarteten Ergebnissen führen.

spaceView

enum (SpaceView)

Angeforderter Typ der Bereichsansicht. Wenn nicht festgelegt, ist der Standardwert SPACE_VIEW_RESOURCE_NAME_ONLY. Anfragen, die SPACE_VIEW_EXPANDED angeben, müssen Bereiche enthalten, die das Lesen von Bereichsdaten ermöglichen, z. B. https://www.googleapis.com/auth/chat.spaces oder https://www.googleapis.com/auth/chat.spaces.readonly.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Antwort mit Gruppenchatbereichen, die genau den aufrufenden Nutzer und die angeforderten Nutzer enthalten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

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

object (Space)

Liste der Bereiche auf der angeforderten (oder ersten) Seite.

nextPageToken

string

Ein Token, das Sie als pageToken senden können, um die nächste Seite mit Ergebnissen abzurufen. Wenn leer, sind keine weiteren Seiten vorhanden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.

SpaceView

Eine Ansicht, die angibt, welche Felder in der Space-Ressource ausgefüllt werden sollen. Um die Kompatibilität mit zukünftigen Versionen zu gewährleisten, empfehlen wir, dass Ihr Code zusätzliche Werte berücksichtigt.

Enums
SPACE_VIEW_UNSPECIFIED Der Standardwert oder nicht festgelegte Wert.
SPACE_VIEW_RESOURCE_NAME_ONLY Füllt nur den Namen der Bereichsressource aus.
SPACE_VIEW_EXPANDED Füllt die Felder der Bereichsressource aus. Hinweis: Das Feld permissionSettings wird nicht ausgefüllt. Anfragen, die SPACE_VIEW_EXPANDED angeben, müssen Bereiche enthalten, die das Lesen von Bereichsdaten ermöglichen, z. B. https://www.googleapis.com/auth/chat.spaces oder https://www.googleapis.com/auth/chat.spaces.readonly.