Method: spaces.setup

Erstellt einen Gruppenbereich und fügt ihm bestimmte Nutzer hinzu. Der aufrufende Nutzer wird automatisch dem Gruppenbereich hinzugefügt und sollte in der Anfrage nicht als Mitgliedschaft angegeben werden. Ein Beispiel finden Sie unter Gruppenbereich einrichten.

Wenn Sie die hinzuzufügenden menschlichen Mitglieder angeben möchten, fügen Sie Mitgliedschaften mit der entsprechenden member.name im SetUpSpaceRequest hinzu. 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 Personen-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 einige Mitglieder blockiert oder von ihnen blockiert wird, 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 DN wird nicht erstellt.

Wenn Sie eine DN 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 aufrufenden App einzurichten. Informationen dazu, wie Sie die aufrufende App als Mitglied eines Gruppenbereichs oder als bestehende Direktnachricht zwischen zwei menschlichen Nutzern hinzufügen, finden Sie unter Mitgliedschaft erstellen.

Wenn bereits eine DN zwischen zwei Nutzern besteht, wird die vorhandene DN zurückgegeben, auch wenn ein Nutzer den anderen bei der Anfrage blockiert.

Gruppenbereiche mit Antwortthreads werden nicht unterstützt. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Ein vorhandener Gruppenbereich innerhalb der Google Workspace-Organisation verwendet diesen Anzeigenamen möglicherweise bereits.

Erfordert die 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. Ein vorhandener Gruppenbereich innerhalb der Google Workspace-Organisation verwendet diesen Anzeigenamen möglicherweise bereits.

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

Wenn Sie eine 1:1-Unterhaltung zwischen zwei Personen starten möchten, setzen Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf false. Legen Sie weder Space.displayName noch Space.spaceDetails fest.

Wenn Sie eine 1:1-Unterhaltung zwischen einem Nutzer und der aufrufenden 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. Es wird eine zufällige UUID empfohlen. Wenn Sie eine vorhandene Anfrage-ID angeben, wird der mit dieser ID erstellte Gruppenbereich zurückgegeben und kein neuer Gruppenbereich erstellt. Wenn Sie eine 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, die in den Gruppenbereich eingeladen werden sollen. Lassen Sie den aufrufenden Nutzer aus, da er automatisch hinzugefügt wird.

Das Set lässt derzeit zusätzlich zum Aufrufer bis zu 20 Mitgliedschaften zu.

Das Feld Membership.member muss eine user enthalten, bei der name ausgefüllt ist (Format: users/{user}) und type auf User.Type.HUMAN festgelegt ist. Nutzer können nur beim Einrichten eines Gruppenbereichs hinzugefügt werden. Chat-Apps werden nur bei der Einrichtung von Direktnachrichten über die 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.

Optional, wenn Sie Space.spaceType auf SPACE setzen.

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

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

Das Feld muss leer sein, wenn eine 1:1-Unterhaltung zwischen einem Nutzer und der aufrufenden 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.