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. Verwenden Sie users/{user}, um einen menschlichen Nutzer hinzuzufügen. Dabei ist {user} entweder die {person_id} für die Person aus der People API oder die id für den Nutzer in der Admin SDK Directory API. Wenn die People API Person resourceName beispielsweise people/123456789 ist, können Sie den Nutzer dem Gruppenbereich hinzufügen, indem Sie eine Mitgliedschaft mit users/123456789 als member.name hinzufügen.

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 oder Gastzugriff werden nicht unterstützt.

Erfordert die Nutzerauthentifizierung und den Bereich chat.spaces.create oder chat.spaces.

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.

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 ersten Nutzer der Domain, die in den Gruppenbereich eingeladen wurden. Der anrufende Nutzer wird dem Gruppenbereich automatisch hinzugefügt und sollte nicht als Mitgliedschaft angegeben werden.

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

Das Feld Membership.member muss einen Nutzer mit name und User.Type.HUMAN enthalten. Alle anderen Felder werden ignoriert.

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.

Nicht unterstützt: Gastnutzer einladen oder andere Chat-Apps hinzufügen

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.