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,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
Felder
name

string

Ressourcenname des Gruppenbereichs.

Format: spaces/{space}

Dabei steht {space} für die vom System zugewiesene ID für den Gruppenbereich. Sie können die Gruppenbereichs-ID durch Aufrufen der Methode spaces.list() oder über die URL des Gruppenbereichs abrufen. Wenn die URL des Gruppenbereichs beispielsweise https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA lautet, ist die ID des Gruppenbereichs AAAAAAAAA.
type
(deprecated)

enum (Type)

Nur Ausgabe. Verworfen. Verwenden Sie stattdessen spaceType. Der Typ eines Gruppenbereichs.
spaceType

enum (SpaceType)

Die Art des Gruppenbereichs. Erforderlich beim Erstellen eines Gruppenbereichs oder Aktualisieren des Gruppenbereichstyps. Ausgabe nur für andere Verwendungen.
singleUserBotDm

boolean

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

boolean

Nur Ausgabe. Verworfen. Verwenden Sie stattdessen spaceThreadingState. Ob Nachrichten in diesem Gruppenbereich in Threads angezeigt werden.
displayName

string

Der Anzeigename des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich mit einer spaceType von SPACE erstellen. Wenn Sie beim Erstellen eines Gruppenbereichs oder beim Aktualisieren von displayName die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Möglicherweise wird dieser Anzeigename bereits für einen 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 in diesem Gruppenbereich beliebige Google Chat-Nutzer als Mitglieder zugelassen sind. Wird beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation eingegeben. Lassen Sie dieses Feld weg, wenn Sie unter den folgenden Bedingungen Gruppenbereiche erstellen:

  • Der authentifizierte Nutzer verwendet ein Privatnutzerkonto (nicht verwaltetes Nutzerkonto). Standardmäßig kann jeder Google Chat-Nutzer in einem Gruppenbereich, der von einem Privatnutzerkonto erstellt wurde, die Berechtigung erteilen.

Für vorhandene Gruppenbereiche wird dieses Feld nur für die Ausgabe verwendet.
spaceThreadingState

enum (SpaceThreadingState)

Nur Ausgabe. Der Status der Unterhaltungsbereiche 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 in Import Mode im Rahmen einer Datenmigration zu Google Workspace erstellt wird. Während Gruppenbereiche importiert werden, sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist.

Zum Erstellen eines Gruppenbereichs in Import Mode ist eine Nutzerauthentifizierung erforderlich.
createTime

string (Timestamp format)

Optional. Nicht veränderbar. Bei Gruppenbereichen, die in Google Chat erstellt wurden, ist dies der Zeitpunkt, zu dem der Gruppenbereich erstellt wurde. Dieses Feld dient nur der Ausgabe, es sei denn, es wird in Gruppenbereichen im Importmodus verwendet.

Legen Sie für Gruppenbereiche im Importmodus in diesem Feld den Zeitstempel fest, zu dem der Gruppenbereich in der Quelle erstellt wurde, um den ursprünglichen Erstellungszeitpunkt beizubehalten.

Wird nur in der Ausgabe dargestellt, wenn spaceType GROUP_CHAT oder SPACE ist.
lastActiveTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.
adminInstalled

boolean

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

Damit die Installation durch Administratoren unterstützt wird, muss die Chat-App Direktnachrichten enthalten.
membershipCount

object (MembershipCount)

Nur Ausgabe. Die Anzahl der Mitgliedschaften, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn spaceType SPACE, DIRECT_MESSAGE oder GROUP_CHAT ist.
accessSettings

object (AccessSettings)

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

string

Nur Ausgabe. Der URI, über den ein Nutzer auf den Gruppenbereich zugreifen kann.
customer

string

Optional. Nicht veränderbar. Die Kunden-ID der Domain des Gruppenbereichs. Nur erforderlich, wenn ein Gruppenbereich mit App-Authentifizierung erstellt wird und SpaceType den Wert SPACE hat. Andernfalls sollte nicht festgelegt werden.

Im Format customers/{customer}, wobei customer die id aus der [Admin SDK-Kundenressource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) ist. Bei privaten Apps kann der Alias customers/my_customer auch verwendet werden, um den Gruppenbereich in derselben Google Workspace-Organisation wie die App zu erstellen.

Bei DMs ist dieses Feld leer.

Union-Feld space_permission_settings. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn space_type den Wert SPACE hat.

Erfordert die Nutzerauthentifizierung. Für space_permission_settings ist nur einer der folgenden Werte zulässig:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Optional. Nur Eingabe. Vordefinierte Berechtigungseinstellungen für Gruppenbereiche, die nur beim Erstellen eines Gruppenbereichs eingegeben werden. Wenn das Feld nicht festgelegt ist, wird ein Gruppenbereich erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen in das Feld PermissionSettings eingefügt.
permissionSettings

object (PermissionSettings)

Optional. Berechtigungseinstellungen für den Gruppenbereich für vorhandene Gruppenbereiche. Eingabe zum Aktualisieren der genauen Berechtigungseinstellungen für den Gruppenbereich, wobei vorhandene Berechtigungseinstellungen ersetzt werden. Die Ausgabe enthält die aktuellen Berechtigungseinstellungen.

Typ

Eingestellt: Verwende stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED Reserviert.
ROOM Unterhaltungen zwischen zwei oder mehr Personen.
DM 1:1-Direktnachricht zwischen einem Nutzer und einer Chat-App, bei der alle Nachrichten in einer flachen Form dargestellt werden. Dies gilt nicht für Direktnachrichten zwischen zwei Personen.

SpaceType

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

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

SpaceThreadingState

Gibt den Thread-Status im Chatbereich an.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Reserviert.
THREADED_MESSAGES Namensgruppenbereiche, die Nachrichtenthreads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie innerhalb des Threads antworten, sodass die Antwort im Kontext der ursprünglichen Nachricht bleibt.
GROUPED_MESSAGES Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen geordnet ist. Themen und die dazugehörigen Antworten werden gruppiert.
UNTHREADED_MESSAGES Direktnachrichten (DNs) zwischen zwei Personen und Gruppenunterhaltungen zwischen drei oder mehr Personen.

SpaceDetails

Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.

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

string

Optional. Eine Beschreibung des Gruppenbereichs. Sie können beispielsweise das Diskussionsthema, den Zweck oder die Teilnehmer des Gruppenbereichs beschreiben.

Unterstützt bis zu 150 Zeichen.
guidelines

string

Optional. Regeln, Erwartungen und Etikette im Raum.

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 Unterhaltungen werden 24 Stunden lang aufbewahrt.
HISTORY_ON Verlauf aktiviert. In den Vault-Aufbewahrungsregeln der Organisation ist festgelegt, wie lange Nachrichten und Threads aufbewahrt werden.

MembershipCount

Gibt die Anzahl der Mitgliedschaften in einem Gruppenbereich an, gruppiert in Kategorien.

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

integer

Anzahl der menschlichen Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nicht berücksichtigt werden Nutzer, die durch Mitgliedschaft in einer verbundenen Gruppe beigetreten sind.
joinedGroupCount

integer

Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

AccessSettings

Die Zugriffseinstellung für den Gruppenbereich.

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 den Gruppenbereich finden, ihm beitreten und sich eine Vorschau der Nachrichten im Gruppenbereich ansehen kann. Wenn diese Option nicht festgelegt ist, können nur Nutzer oder Google-Gruppen, die einzeln eingeladen oder dem Gruppenbereich hinzugefügt wurden, darauf zugreifen. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für eine Zielgruppe sichtbar machen.

Format: audiences/{audience}

Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie audiences/default fest.

Die Lektüre der Zielgruppe hilft:

Dieses Feld wird nicht ausgefüllt, wenn der Umfang chat.bot mit der App-Authentifizierung verwendet wird.

Zum Festlegen der Zielgruppe ist eine Nutzerauthentifizierung erforderlich.

AccessState

Stellt den Zugriffsstatus des Gruppenbereichs dar.

Enums
ACCESS_STATE_UNSPECIFIED Der Zugriffsstatus ist unbekannt oder wird in dieser API nicht unterstützt.
PRIVATE Nur Nutzer oder Google-Gruppen, die von anderen Nutzern oder Google Workspace-Administratoren einzeln hinzugefügt oder eingeladen wurden, können den Gruppenbereich finden und darauf zugreifen.
DISCOVERABLE

Ein Administrator des Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die einzeln zum Gruppenbereich hinzugefügt oder dazu eingeladen wurden, können den Gruppenbereich ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie unter Gruppenbereich für bestimmte Nutzer sichtbar machen.

Zum Erstellen sichtbarer Gruppenbereiche ist eine Nutzerauthentifizierung erforderlich.

PredefinedPermissionSettings

Vordefinierte Berechtigungseinstellungen, die Sie nur beim Erstellen eines benannten Bereichs festlegen können. Weitere Einstellungen werden möglicherweise in Zukunft hinzugefügt. Weitere Informationen zu den Berechtigungseinstellungen für benannte Gruppenbereiche finden Sie unter Gruppenbereiche.

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Nicht angegeben Nicht verwenden.
COLLABORATION_SPACE Einstellung, mit der der Gruppenbereich zu einem Gruppenbereich für die Zusammenarbeit wird, in dem alle Mitglieder Nachrichten posten können.
ANNOUNCEMENT_SPACE Einstellung, mit der der Gruppenbereich in einen Gruppenbereich für Ankündigungen umgewandelt wird, in dem nur Administratoren des Gruppenbereichs Nachrichten posten können.

PermissionSettings

Berechtigungseinstellungen, die Sie beim Aktualisieren eines vorhandenen Gruppenbereichs angeben können.

Wenn Sie beim Erstellen eines Gruppenbereichs Berechtigungseinstellungen festlegen möchten, geben Sie in Ihrer Anfrage das Feld PredefinedPermissionSettings an.

JSON-Darstellung 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
Felder
manageMembersAndGroups

object (PermissionSetting)

Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich.
modifySpaceDetails

object (PermissionSetting)

Einstellung zum Aktualisieren des Namens, des Avatars, der Beschreibung und der Richtlinien des Gruppenbereichs.
toggleHistory

object (PermissionSetting)

Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs.
useAtMentionAll

object (PermissionSetting)

Einstellung für die Verwendung von @alle in einem Gruppenbereich.
manageApps

object (PermissionSetting)

Einstellung zum Verwalten von Apps in einem Gruppenbereich.
manageWebhooks

object (PermissionSetting)

Einstellung zum Verwalten von Webhooks in einem Gruppenbereich.
postMessages

object (PermissionSetting)

Nur Ausgabe. Einstellung zum Posten von Nachrichten in einem Gruppenbereich.
replyMessages

object (PermissionSetting)

Einstellung für das Beantworten von Nachrichten in einem Gruppenbereich.

PermissionSetting

Stellt eine Berechtigungseinstellung für einen Gruppenbereich dar.

JSON-Darstellung 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
Felder
managersAllowed

boolean

Ob Administratoren von Gruppenbereichen diese Berechtigung haben.
membersAllowed

boolean

Gibt an, ob Nutzer, die keine Administratoren sind, diese Berechtigung haben.

Methoden

completeImport

 Schließt den Importvorgang für den angegebenen Bereich ab und macht ihn für Nutzer sichtbar.

create

 Erstellt einen Gruppenbereich ohne Mitglieder.

delete

 Löscht einen benannten Gruppenbereich.

findDirectMessage

 Die vorhandene Direktnachricht mit dem angegebenen Nutzer wird zurückgegeben.

get

 Gibt Details zu einem Gruppenbereich zurück.

list

 Listet Gruppenbereiche auf, in denen der Anrufer Mitglied ist.

patch

 Aktualisiert einen Gruppenbereich.
Eine Liste der Gruppenbereiche in einer Google Workspace-Organisation wird basierend auf der Suche eines Administrators zurückgegeben.

setup

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