REST Resource: spaces

Ressource: Gruppenbereich

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,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
Felder
name

string

Ressourcenname des Gruppenbereichs.

Format: spaces/{space}

type
(deprecated)

enum (Type)

Nur Ausgabe. Eingestellt: Verwenden Sie stattdessen spaceType. Der Typ eines Leerzeichens.

spaceType

enum (SpaceType)

Die Art des Gruppenbereichs. Erforderlich, wenn ein Gruppenbereich erstellt oder dessen Typ aktualisiert wird. Ausgabe nur für andere Zwecke.

singleUserBotDm

boolean

Optional. Gibt an, ob der Gruppenbereich eine DN zwischen einer Chat-App und einer einzelnen Person ist.

threaded
(deprecated)

boolean

Nur Ausgabe. Eingestellt: Verwenden Sie stattdessen spaceThreadingState. Gibt an, ob Nachrichten in diesem Gruppenbereich als Threads gespeichert sind.

displayName

string

Anzeigename des Gruppenbereichs Erforderlich beim Erstellen eines Gruppenbereichs. Wenn Sie beim Erstellen eines Gruppenbereichs oder beim Aktualisieren der displayName die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Dieser Anzeigename wird möglicherweise bereits von einem vorhandenen Gruppenbereich in der Google Workspace-Organisation verwendet.

Bei Direktnachrichten ist dieses Feld möglicherweise leer.

Unterstützt bis zu 128 Zeichen.

externalUserAllowed

boolean

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

  • Der authentifizierte Nutzer verwendet ein Privatnutzerkonto (nicht verwaltetes Nutzerkonto). Standardmäßig sind in einem von einem Privatnutzerkonto erstellten Gruppenbereich alle Google Chat-Nutzer zulässig.

  • Der Gruppenbereich wird für den Import von Daten in Google Chat verwendet, da in Gruppenbereichen im Importmodus nur Mitglieder aus derselben Google Workspace-Organisation zulässig sein dürfen. Im Rahmen des Google Workspace-Entwicklervorschauprogramms können jedoch alle Google Chat-Nutzer in Gruppenbereichen im Importmodus erlaubt sein, sodass dieses Feld für Gruppenbereiche im Importmodus festgelegt werden kann.

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 einer 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. Nicht veränderbar. Der Zeitpunkt, zu dem der Gruppenbereich in Google Chat erstellt wurde. Dieses Feld wird nur ausgegeben, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet.

Legen Sie bei Gruppenbereichen im Importmodus in diesem Feld den bisherigen Zeitstempel fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, damit der ursprüngliche Erstellungszeitpunkt beibehalten wird.

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

lastActiveTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.

adminInstalled

boolean

Nur Ausgabe. Gibt bei Direktnachrichten (DM) in einer Chat-App an, ob der Gruppenbereich von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation Direktnachrichten über eine Chat-App installieren und einrichten.

Damit die Installation durch einen Administrator unterstützt wird, muss Ihre Chat-App Direktnachrichten enthalten.

membershipCount

object (MembershipCount)

Nur Ausgabe. Die Anzahl der beigetretenen Mitgliedschaften, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn spaceType den Wert SPACE, DIRECT_MESSAGE oder GROUP_CHAT hat.

accessSettings

object (AccessSettings)

Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur gefüllt, wenn spaceType den Wert SPACE hat.

spaceUri

string

Nur Ausgabe. Der URI des Gruppenbereichs.

Typ

Eingestellt: Verwenden Sie stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED Reserviert.
ROOM Gespräche zwischen zwei oder mehr Menschen
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.

SpaceType

Die Art 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 teilen und zusammenarbeiten können. Eine SPACE kann Chat-Apps enthalten.
GROUP_CHAT Gruppenunterhaltungen zwischen drei oder mehr Personen Eine GROUP_CHAT kann Chat-Apps enthalten.
DIRECT_MESSAGE 1:1-Nachrichten zwischen zwei Personen oder einem Nutzer und einer Chat-App.

SpaceThreadingState

Gibt den Typ des Threading-Status im Chatbereich an.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Reserviert.
THREADED_MESSAGES Benannte Gruppenbereiche, in denen E-Mail-Konversationen unterstützt werden Wenn ein Nutzer auf eine Nachricht antwortet, kann er im Thread antworten, wodurch seine Antwort im Kontext der ursprünglichen Nachricht beibehalten wird.
GROUPED_MESSAGES Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen geordnet ist. Themen und die zugehörigen Antworten werden gruppiert.
UNTHREADED_MESSAGES Direktnachrichten (DN) zwischen zwei Personen und Gruppenunterhaltungen zwischen drei oder mehr Personen

SpaceDetails

Details zum Gruppenbereich, einschließlich einer Beschreibung und Regeln

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

string

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

Unterstützt bis zu 150 Zeichen.

guidelines

string

Optional. Regeln, Erwartungen und Etikette im Gruppenbereich

Unterstützt bis zu 5.000 Zeichen.

HistoryState

Der Verlaufsstatus für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungsthreads nach dem Erstellen gespeichert 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.

MembershipCount

Die Anzahl der Mitgliedschaften eines Gruppenbereichs, gruppiert in Kategorien.

JSON-Darstellung
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
Felder
joinedDirectHumanUserCount

integer

Anzahl der Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über die Mitgliedschaft in einer Gruppe beigetreten sind, werden nicht berücksichtigt.

joinedGroupCount

integer

Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

AccessSettings

Stellt die Zugriffseinstellung des Gruppenbereichs dar.

JSON-Darstellung
{
  "accessState": enum (AccessState),
  "audience": string
}
Felder
accessState

enum (AccessState)

Nur Ausgabe. Gibt den Zugriffsstatus des Gruppenbereichs an.

audience

string

Optional. Der Ressourcenname der Zielgruppe, die auf den Gruppenbereich zugreifen kann. Geben Sie in diesem Feld eine gültige Zielgruppen-ID an, um den Gruppenbereich sichtbar zu machen, oder verwenden Sie den Alias audiences/default, um den Gruppenbereich mit der Standardeinstellung für den Zugriff in der Admin-Konsole festzulegen. Weitere Informationen finden Sie unter Gruppenbereich für eine Zielgruppe sichtbar machen. Entfernen Sie das Häkchen aus diesem Feld, damit der Gruppenbereich eingeschränkt wird. Wird nur ausgefüllt, wenn der Gruppenbereich sichtbar ist. Format: audiences/{audience}, audiences/default kann als Alias der standardmäßigen Freigabeeinstellung in Chats verwendet werden.

AccessState

Stellt den Zugriffsstatus des Gruppenbereichs dar.

Enums
ACCESS_STATE_UNSPECIFIED Der Zugriffsstatus ist unbekannt oder wird in dieser API nicht unterstützt.
PRIVATE Der Gruppenbereich ist für hinzugefügte oder eingeladene Mitglieder oder Gruppen sichtbar.
DISCOVERABLE Der Gruppenbereich ist für die ausgewählte Zielgruppe sowie für hinzugefügte oder eingeladene Mitglieder oder Gruppen sichtbar.

Methoden

completeImport

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

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 Gruppenbereich zurück

list

Listet Gruppenbereiche auf, in denen der Anrufer Mitglied ist.

patch

Aktualisiert einen Gruppenbereich.

setup

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