Method: spaces.setup

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

Wenn Sie die hinzuzufügenden Nutzer hinzufügen möchten, fügen Sie in der SetUpSpaceRequest eine Mitgliedschaft mit der entsprechenden member.name hinzu. Wenn Sie einen menschlichen Nutzer hinzufügen möchten, verwenden Sie users/{user}. Dabei kann {user} die E-Mail-Adresse des Nutzers sein. Für Nutzer in derselben Workspace-Organisation kann {user} auch {person_id} für die Person aus der People API oder id für den Nutzer in der Directory API sein. Wenn die People API-Person resourceName für user@example.com beispielsweise people/123456789 ist, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie membership.member.name auf users/user@example.com oder users/123456789 festlegen.

Wenn der Anrufer in einem Gruppenbereich oder Gruppenchat einen Mitglied blockiert oder blockiert, werden er dem erstellten Gruppenbereich nicht hinzugefügt.

Wenn Sie eine Direktnachricht zwischen dem Nutzer und dem anderen Nutzer erstellen möchten, geben Sie genau eine Mitgliedschaft an, die den 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 anrufenden 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 DN mit der Anruf-App einzurichten. Weitere Informationen dazu, wie Sie die Anruf-App als Mitglied eines Gruppenbereichs oder als bestehende DN zwischen zwei menschlichen Nutzern hinzufügen, finden Sie unter Mitgliedschaft erstellen.

Wenn bereits eine DN zwischen zwei Nutzern vorhanden ist, wird die vorhandene DN zurückgegeben, auch wenn ein Nutzer die andere zum Zeitpunkt 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 für einen Gruppenbereich in der Google Workspace-Organisation verwendet.

Erfordert 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 geben Sie Space.displayName ein. Wenn Sie beim Einrichten eines Gruppenbereichs die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Dieser Anzeigename wird möglicherweise bereits für einen Gruppenbereich in der Google Workspace-Organisation verwendet.

Um einen Gruppenchat zu erstellen, setze Space.spaceType auf GROUP_CHAT. Legen Sie nicht Space.displayName fest.

Wenn Sie eine 1:1-Unterhaltung zwischen Menschen erstellen 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 einer Person und der 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 Gruppenbereich DIRECT_MESSAGE vorhanden ist, wird dieser Gruppenbereich zurückgegeben, anstatt einen neuen Gruppenbereich 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 Gruppenbereich, der mit dieser ID erstellt wurde, zurückgegeben, anstatt einen neuen Gruppenbereich 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, die in den Gruppenbereich eingeladen werden sollen. Lassen Sie den anrufenden Nutzer aus, weil er automatisch hinzugefügt wird.

Bei diesem Set können bis zu 20 Mitglieder hinzukommen.

Das Feld Membership.member muss ein user enthalten, in das name eingetragen ist (Format: users/{user}) und type auf User.Type.HUMAN festgelegt ist. Sie können nur dann Nutzer hinzufügen, wenn ein Gruppenbereich eingerichtet wird. Das Hinzufügen von Chat-Apps wird nur für die Einrichtung von Direktnachrichten in der Anruf-App unterstützt. Sie können Mitglieder auch über die E-Mail-Adresse des Nutzers als Alias für {user} hinzufügen. 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 Space.spaceType auf SPACE gesetzt wird.

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

Erforderlich, wenn Space.spaceType mit einem menschlichen Nutzer auf DIRECT_MESSAGE gesetzt wird, zusammen mit genau einer Mitgliedschaft.

Muss leer sein, wenn Sie eine 1:1-Unterhaltung zwischen einer Person und der Chat-App erstellen, wenn Sie Space.spaceType auf DIRECT_MESSAGE und Space.singleUserBotDm auf true setzen.

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.