Erstellt einen Gruppenbereich und fügt ihm bestimmte Nutzer hinzu. Der aufrufende Nutzer wird dem Gruppenbereich automatisch hinzugefügt und sollte in der Anfrage nicht als Mitgliedschaft angegeben werden. Ein Beispiel finden Sie unter Gruppenbereich mit ersten Mitgliedern einrichten.
Fügen Sie Mitgliedschaften mit der entsprechenden membership.member.name
hinzu, um die Personen anzugeben, die hinzugefügt werden sollen. Verwenden Sie users/{user}
, um einen menschlichen Nutzer hinzuzufügen, wobei {user}
die E-Mail-Adresse des Nutzers sein kann. Für Nutzer in derselben Workspace-Organisation kann {user}
auch die id
für die Person aus der People API oder die id
für den Nutzer in der Directory API sein. Wenn die Person-Profil-ID der People API für user@example.com
beispielsweise 123456789
lautet, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie membership.member.name
auf users/user@example.com
oder users/123456789
setzen.
Wenn der Anrufer in einem Gruppenbereich oder Gruppenchat mit einem Namen blockiert oder von einigen Mitgliedern blockiert wird oder nicht berechtigt ist, einige Mitglieder hinzuzufügen, werden diese Mitglieder dem erstellten Gruppenbereich nicht hinzugefügt.
Wenn Sie eine Direktnachricht (DM) zwischen dem aufrufenden Nutzer und einem anderen menschlichen Nutzer erstellen möchten, geben Sie genau eine Mitgliedschaft für den menschlichen Nutzer an. Wenn ein Nutzer den anderen blockiert, schlägt die Anfrage fehl und die DM wird nicht erstellt.
Wenn Sie eine DM zwischen dem aufrufenden Nutzer und der aufrufenden App erstellen möchten, setzen Sie Space.singleUserBotDm
auf true
und geben Sie keine Mitgliedschaften an. Sie können diese Methode nur verwenden, um eine DN mit der Anruf-App einzurichten. Wie Sie die Anruf-App als Mitglied eines Gruppenbereichs oder als bestehende Direktnachricht zwischen zwei menschlichen Nutzern hinzufügen, erfahren Sie im Hilfeartikel Nutzer oder Apps in einen Gruppenbereich einladen oder hinzufügen.
Wenn zwei Nutzer bereits eine DM haben, wird die vorhandene Direktnachricht zurückgegeben, selbst wenn ein Nutzer den anderen bei der Anfrage blockiert.
Gruppenbereiche mit Unterhaltungsthreads für Antworten werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS
erhalten, versuchen Sie es mit einem anderen displayName
. Dieser Anzeigename wird möglicherweise bereits von einem vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.
Erfordert eine Nutzerauthentifizierung.
HTTP-Anfrage
POST https://chat.googleapis.com/v1/spaces:setup
Die URL verwendet die Syntax der gRPC-Transcodierung.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "space": { object ( |
Felder | |
---|---|
space |
Erforderlich. Wenn Sie einen Gruppenbereich erstellen möchten, setzen Sie „ Wenn du einen Gruppenchat erstellen möchtest, setze Wenn Sie eine 1:1-Unterhaltung zwischen zwei Personen starten möchten, setzen Sie Wenn Sie eine 1:1-Unterhaltung zwischen einem Nutzer und der entsprechenden Chat-App erstellen möchten, setzen Sie Wenn bereits ein |
requestId |
Optional. Eine eindeutige Kennung für diese Anfrage. Eine zufällige UUID wird empfohlen. Wenn Sie eine vorhandene Anfrage-ID angeben, wird der mit dieser ID erstellte Gruppenbereich zurückgegeben und kein neuer Bereich erstellt. Wenn Sie eine vorhandene Anfrage-ID aus derselben Chat-App mit einem anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben. |
memberships[] |
Optional. Die Google Chat-Nutzer, die in den Gruppenbereich eingeladen werden sollen. Lassen Sie den aufrufenden Nutzer aus, da er automatisch hinzugefügt wird. Neben dem Anrufer sind derzeit bis zu 20 Mitgliedschaften möglich. Für die menschliche Mitgliedschaft muss das Feld Optional beim Festlegen von Erforderlich, wenn Erforderlich, wenn Das Feld muss leer sein, wenn du eine 1:1-Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellst (wenn |
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Space
.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.