REST Resource: spaces

Ressource: Space

Ein Gruppenbereich in Google Chat. Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehr Nutzern oder 1:1-Nachrichten zwischen einem Nutzer und einer Chat-App.

JSON-Darstellung 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "adminInstalled": boolean
}
Felder
name

string

Ressourcenname des Gruppenbereichs.

Format: spaces/{space}
type
(deprecated)

enum (Type)

Nur Ausgabe. Eingestellt: Verwende stattdessen spaceType. Der Typ eines Leerzeichens.
spaceType

enum (SpaceType)

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs oder Aktualisieren des Gruppenbereichstyps eines Gruppenbereichs. Ausgabe nur für andere Zwecke.
singleUserBotDm

boolean

Optional. Gibt an, ob der Gruppenbereich eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person ist.
threaded
(deprecated)

boolean

Nur Ausgabe. Eingestellt: Verwende stattdessen spaceThreadingState. Gibt an, ob sich Nachrichten in diesem Gruppenbereich als Unterhaltungsthreads befinden.
displayName

string

Der Anzeigename des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs. Wenn Sie beim Erstellen eines Gruppenbereichs oder beim Aktualisieren von displayName 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.

Bei Direktnachrichten ist dieses Feld möglicherweise leer.

Unterstützt bis zu 128 Zeichen.
externalUserAllowed

boolean

Nicht veränderbar. Gibt an, ob in diesem Gruppenbereich Google Chat-Nutzer als Mitglied zulässig sind. Eingabe beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation. Lassen Sie dieses Feld aus, wenn Sie Gruppenbereiche unter den folgenden Bedingungen erstellen:

  • Der authentifizierte Nutzer verwendet ein Google-Konto. Standardmäßig sind im Gruppenbereich alle Google Chat-Nutzer zulässig.

  • Der Gruppenbereich wird verwendet, um Daten in Google Chat zu importieren. In Gruppenbereichen im Importmodus dürfen nur Mitglieder aus derselben Google Workspace-Organisation zulässig sein.

Bei vorhandenen Gruppenbereichen wird dieses Feld nur ausgegeben.
spaceThreadingState

enum (SpaceThreadingState)

Nur Ausgabe. Der Threading-Status im Chatbereich.
spaceDetails

object (SpaceDetails)

Details zum Gruppenbereich, einschließlich Beschreibung und Regeln
spaceHistoryState

enum (HistoryState)

Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich.
importMode

boolean

Optional. Gibt an, ob dieser Gruppenbereich im Rahmen einer Datenmigration in Google Workspace in Import Mode erstellt wird. Während Gruppenbereiche importiert werden, sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist.

createTime

string (Timestamp format)

Optional. Bei Gruppenbereichen, die in Google Chat erstellt wurden, der Zeitpunkt, an dem der Gruppenbereich erstellt wurde. Dieses Feld wird nur ausgegeben, wenn es nicht in importierten Gruppenbereichen verwendet wird.

Legen Sie bei importierten Gruppenbereichen den Zeitstempel des bisherigen Zeitpunkts fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, damit der ursprüngliche Erstellungszeitpunkt beibehalten wird.

Wird nur in die Ausgabe eingefügt, wenn spaceType den Wert GROUP_CHAT oder SPACE hat.

adminInstalled

boolean

Nur Ausgabe. Gibt an, ob die Chat App von einem Google Workspace-Administrator installiert wurde. Administratoren können eine Chat-App für ihre Domain, Organisationseinheit oder eine Nutzergruppe installieren.

Administratoren können Chat-Apps nur für Direktnachrichten zwischen Nutzern und der App installieren. Damit die Installation durch Administratoren unterstützt wird, muss Ihre App Direktnachrichten enthalten.

Typ

Eingestellt: Verwende stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED
ROOM Gespräche zwischen zwei oder mehr Nutzern.
DM 1:1-Direktnachricht zwischen einem Nutzer und einer Chat-App, bei der alle Nachrichten flach dargestellt werden. Hinweis: Dies gilt nicht für Direktnachrichten zwischen zwei Nutzern.

Gruppenbereichstyp

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen oder Aktualisieren eines Gruppenbereichs. Ausgabe nur für andere Zwecke.

Enums
SPACE_TYPE_UNSPECIFIED Reserviert.
SPACE Ein Ort, an dem Nutzer Nachrichten senden, Dateien freigeben und zusammenarbeiten können. Eine SPACE kann Chat-Apps enthalten.
GROUP_CHAT Gruppenunterhaltungen mit drei oder mehr Teilnehmern Eine GROUP_CHAT kann Chat-Apps enthalten.
DIRECT_MESSAGE 1:1-Nachrichten zwischen zwei Personen oder einem Menschen und einer Chat-App.

Space-Threading-Zustand

Gibt den Threading-Status im Chatbereich an.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Reserviert.
THREADED_MESSAGES Benannte Gruppenbereiche, die Nachrichtenthreads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie in einer Konversation antworten. Die Antwort bleibt dabei im Kontext der ursprünglichen Nachricht erhalten.
GROUPED_MESSAGES Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen organisiert ist. Themen und zugehörige Antworten werden gruppiert.
UNTHREADED_MESSAGES Direktnachrichten (DN) zwischen zwei Personen und Gruppenunterhaltungen mit drei oder mehr Personen

Space-Details

Details zum Gruppenbereich, einschließlich Beschreibung und Regeln

JSON-Darstellung 
{
  "description": string,
  "guidelines": string
}
Felder
description

string

Optional. Eine Beschreibung des Gruppenbereichs. Beschreiben Sie beispielsweise das Diskussionsthema, den funktionellen Zweck oder die Teilnehmer.

Unterstützt bis zu 150 Zeichen.
guidelines

string

Optional. Die Regeln, Erwartungen und Etikette im Gruppenbereich.

Unterstützt bis zu 5.000 Zeichen.

Verlaufszustand

Der Verlaufsstatus für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungsthreads nach der Erstellung aufbewahrt werden.

Enums
HISTORY_STATE_UNSPECIFIED Standardwert. Nicht verwenden.
HISTORY_OFF Verlauf deaktiviert. Nachrichten und Threads werden 24 Stunden lang gespeichert.
HISTORY_ON Verlauf aktiviert. In den Aufbewahrungsregeln in Vault der Organisation ist festgelegt, wie lange Nachrichten und Threads aufbewahrt werden.

Methoden

completeImport

 Damit wird der Importvorgang für den angegebenen Gruppenbereich abgeschlossen und für Nutzer sichtbar gemacht.

create

 Erstellt einen benannten Gruppenbereich.

delete

 Löscht einen benannten Gruppenbereich.

findDirectMessage

 Gibt die vorhandene Direktnachricht an den angegebenen Nutzer zurück

get

 Gibt Details zu einem Leerzeichen zurück.

list

 Listet Gruppenbereiche auf, in denen der Aufrufer Mitglied ist.

patch

 Aktualisiert einen Gruppenbereich.

setup

 Erstellt einen Gruppenbereich und fügt ihm bestimmte Nutzer hinzu.