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. Ein Beispiel finden Sie unter Gruppenchats finden.

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 menschliche (nicht appbezogene) Mitglieder enthalten. Bei einer Anfrage, die nicht menschliche Nutzer enthält, werden keine Bereiche zurückgegeben.

Erfordert 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
user[]
(deprecated)

string

Optional. Eingestellt: Verwenden Sie stattdessen das Feld users.

Ressourcennamen aller menschlichen Nutzer im Gruppenchat mit dem anrufenden 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 anrufenden 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.
users[]

string

Optional. Ressourcennamen aller menschlichen Nutzer im Gruppenchat mit dem anrufenden 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 anrufenden 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 Arbeitsbereiche. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

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

Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 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 bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Token bereitgestellt hat. Die Übergabe unterschiedlicher Werte kann zu unerwarteten Ergebnissen führen.
spaceView

enum (SpaceView)

Angeforderter Typ der Space-Ansicht. Wenn nicht festgelegt, ist der Standardwert SPACE_VIEW_RESOURCE_NAME_ONLY. Anfragen, in denen SPACE_VIEW_EXPANDED angegeben ist, 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 anrufenden 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 Gruppenbereiche auf der angeforderten (oder ersten) Seite.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Ergebnisseite abzurufen. Wenn leer, gibt es keine nachfolgenden Seiten.

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. Damit Ihr Code mit zukünftigen Versionen kompatibel ist, empfehlen wir, dass er zusätzliche Werte berücksichtigt.

Enums
SPACE_VIEW_UNSPECIFIED Der Standardwert bzw. der nicht festgelegte Wert.
SPACE_VIEW_RESOURCE_NAME_ONLY Füllt nur den Ressourcennamen des Gruppenbereichs aus.
SPACE_VIEW_EXPANDED Füllt Felder für Space-Ressourcen aus. Hinweis: Das Feld permissionSettings wird nicht ausgefüllt. Anfragen, in denen SPACE_VIEW_EXPANDED angegeben ist, müssen Bereiche enthalten, die das Lesen von Gruppenbereichsdaten ermöglichen, z. B. https://www.googleapis.com/auth/chat.spaces oder https://www.googleapis.com/auth/chat.spaces.readonly.