Method: spaces.setup

Erstellt einen Gruppenbereich und fügt ihm angegebene Nutzer hinzu. Der anfragende 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.

Um die hinzuzufügenden menschlichen Mitglieder anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden membership.member.name hinzu. Wenn Sie einen Nutzer hinzufügen möchten, verwenden Sie users/{user}. {user} kann die E-Mail-Adresse des Nutzers sein. Bei Nutzern 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 Personenprofil-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 festlegen.

Um die hinzuzufügenden Google-Gruppen anzugeben, fügen Sie Mitgliedschaften mit der entsprechenden membership.group_member.name hinzu. Verwenden Sie groups/{group}, um eine Google-Gruppe hinzuzufügen oder einzuladen, wobei {group} der id für die Gruppe aus der Cloud Identity Groups API ist. Sie können beispielsweise die Cloud Identity Groups Lookup API verwenden, um die ID 123456789 für die Gruppen-E-Mail-Adresse group@example.com abzurufen, und die Gruppe dann dem Gruppenbereich hinzufügen, indem Sie membership.group_member.name auf groups/123456789 setzen. Die E-Mail-Adresse einer Gruppe wird nicht unterstützt und Google-Gruppen können nur in benannten Gruppenbereichen als Mitglieder hinzugefügt werden.

Wenn der Anrufer einige Mitglieder blockiert oder von ihnen blockiert wird oder keine Berechtigung zum Hinzufügen bestimmter Mitglieder hat, werden diese Mitglieder dem erstellten Gruppenbereich nicht hinzugefügt.

Wenn Sie eine Direktnachricht (DN) zwischen dem aufrufenden Nutzer und einem anderen menschlichen Nutzer erstellen möchten, geben Sie genau eine Mitgliedschaft an, die den menschlichen Nutzer repräsentiert. Wenn ein Nutzer den anderen blockiert, schlägt die Anfrage fehl und die DM wird nicht erstellt.

Wenn Sie eine DN zwischen dem aufrufenden Nutzer und der anrufenden 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 Direktnachricht mit der aufrufenden App einzurichten. Wie Sie die Anruf-App als Mitglied eines Gruppenbereichs oder als bestehende DN zwischen zwei menschlichen Nutzern hinzufügen, erfahren Sie im Hilfeartikel Nutzer oder Apps zu Gruppenbereichen einladen oder hinzufügen.

Wenn zwischen zwei Nutzern bereits eine Direktnachricht besteht, wird diese zurückgegeben, auch wenn einer der Nutzer den anderen blockiert, während eine Anfrage gestellt wird.

Gruppenbereiche mit Antworten mit Unterhaltungsthreads werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einer anderen displayName. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden 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 (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
Felder
space

object (Space)

Erforderlich. Space.spaceType ist ein Pflichtfeld.

Wenn Sie einen Gruppenbereich erstellen möchten, setzen Sie Space.spaceType auf SPACE und Space.displayName. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Möglicherweise wird dieser Anzeigename bereits für einen vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Wenn du einen Gruppenchat erstellen möchtest, setze Space.spaceType auf GROUP_CHAT. Legen Sie Space.displayName nicht fest.

Wenn Sie eine 1:1-Unterhaltung zwischen Personen erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false. Legen Sie nicht Space.displayName oder Space.spaceDetails fest.

Wenn Sie eine 1:1-Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellen möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true. Legen Sie weder Space.displayName noch Space.spaceDetails fest.

Wenn bereits ein DIRECT_MESSAGE-Bereich vorhanden ist, wird dieser zurückgegeben, anstatt einen neuen zu erstellen.
requestId

string

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, anstatt einen neuen zu erstellen. Wenn Sie eine vorhandene Anfrage-ID aus derselben Chat-App mit einem anderen authentifizierten Nutzer angeben, wird ein Fehler zurückgegeben.
memberships[]

object (Membership)

Optional. Die Google Chat-Nutzer oder -Gruppen, die zum Beitritt zum Gruppenbereich eingeladen werden sollen. Den anrufenden Nutzer weglassen, da er automatisch hinzugefügt wird.

Derzeit sind zusätzlich zum Anrufer bis zu 20 Mitgliedschaften möglich.

Für die menschliche Mitgliedschaft muss das Feld Membership.member eine user enthalten, bei der name ausgefüllt ist (Format: users/{user}) und type auf User.Type.HUMAN gesetzt ist. Sie können nur bei der Einrichtung eines Gruppenbereichs Nutzer hinzufügen. Das Hinzufügen von Chat-Apps wird nur für die Einrichtung von Direktnachrichten mit der Anruf-App unterstützt. Sie können auch Mitglieder hinzufügen, indem Sie die E-Mail-Adresse des Nutzers als Alias für {user} verwenden. user.name kann beispielsweise users/example@gmail.com sein. Wenn Sie Gmail-Nutzer oder Nutzer aus externen Google Workspace-Domains einladen möchten, muss die E-Mail-Adresse des Nutzers für {user} verwendet werden.

Für die Mitgliedschaft in einer Google-Gruppe muss das Feld Membership.group_member einen group mit einem Wert für name enthalten (Format groups/{group}). Sie können nur dann Google-Gruppen hinzufügen, wenn Sie Space.spaceType auf SPACE festlegen.

Optional, wenn Space.spaceType auf SPACE gesetzt ist.

Erforderlich, wenn Space.spaceType auf GROUP_CHAT festgelegt wird, zusammen mit mindestens zwei Mitgliedschaften.

Erforderlich, wenn Space.spaceType für einen menschlichen Nutzer auf DIRECT_MESSAGE gesetzt wird, zusammen mit genau einer Mitgliedschaft.

Muss leer sein, wenn eine Unterhaltung zwischen einem Nutzer und der anrufenden Chat-App erstellt wird (wenn Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true gesetzt wird).

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.