REST Resource: spaces

Ressource: Gruppenbereich

Einen Gruppenbereich in Google Chat Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehreren Nutzern oder Einzelunterhaltungen 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,
  "importModeExpireTime": 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

Kennung. Ressourcenname des Gruppenbereichs.

Format: spaces/{space}

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

enum (Type)

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

enum (SpaceType)

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

boolean

Optional. Gibt an, ob es sich bei dem Gruppenbereich um eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person handelt.
threaded
(deprecated)

boolean

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

string

Optional. Der Anzeigename des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich mit einer spaceType von SPACE erstellen. Wenn Sie beim Erstellen eines Gruppenbereichs oder Aktualisieren des 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

Optional. 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 in den folgenden Fällen weg, wenn Sie Gruppenbereiche erstellen:

  • Der authentifizierte Nutzer verwendet ein Privatkonto (nicht verwaltetes Nutzerkonto). In einem Gruppenbereich, der von einem privaten Konto erstellt wurde, ist standardmäßig der Zugriff für alle Google Chat-Nutzer erlaubt.

Bei bestehenden Gruppenbereichen dient dieses Feld nur der Ausgabe.
spaceThreadingState

enum (SpaceThreadingState)

Nur Ausgabe. Der Status der Unterhaltungsthreads im Chatbereich.
spaceDetails

object (SpaceDetails)

Optional. Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.
spaceHistoryState

enum (HistoryState)

Optional. 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.

Für das Erstellen eines Gruppenbereichs in Import Mode ist eine Nutzerauthentifizierung erforderlich.
createTime

string (Timestamp format)

Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen ist es die Uhrzeit, zu der 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 die Ausgabe aufgenommen, wenn spaceType GROUP_CHAT oder SPACE ist.
lastActiveTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.
adminInstalled

boolean

Nur Ausgabe. Ob ein Gruppenbereich für Direktnachrichten (DM) mit einer Chat-App von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Chat-App installieren und eine Direktnachricht einrichten.

Damit die Installation durch Administratoren unterstützt wird, muss Ihre Chat-App Direktnachrichten unterstützen.
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 SPACE ist.
spaceUri

string

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

string (Timestamp format)

Nur Ausgabe. Das Datum, an dem der Gruppenbereich automatisch vom System gelöscht wird, wenn er sich noch im Importmodus befindet.

Jeder im Importmodus erstellte Gruppenbereich muss vor Ablauf dieser Frist mit spaces.completeImport aus diesem Modus herausgenommen werden.

Dieses Feld wird nur für Gruppenbereiche ausgefüllt, die im Importmodus erstellt wurden.
customer

string

Optional. Nicht veränderbar. Die Kunden-ID der Domain des Gruppenbereichs. Nur erforderlich, wenn Sie einen Gruppenbereich mit App-Authentifizierung erstellen und SpaceType = SPACE ist. Andernfalls sollte dieser Parameter 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 SPACE ist.

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. Einstellungen für Berechtigungen für Gruppenbereiche für vorhandene Gruppenbereiche Eingabe für die Aktualisierung der genauen Berechtigungseinstellungen für Gruppenbereiche, bei der vorhandene Berechtigungseinstellungen ersetzt werden. Die Ausgabe enthält die aktuellen Berechtigungseinstellungen.

Typ

Verworfen. Verwenden Sie stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED Reserviert.
ROOM Unterhaltungen zwischen zwei oder mehr Personen.
DM Direktnachricht zwischen einer natürlichen Person und einer Chat-App, bei der alle Nachrichten flach sind. Direktnachrichten zwischen zwei Personen sind davon ausgenommen.

SpaceType

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 teilen und zusammenarbeiten können. Eine SPACE kann Chat-Apps enthalten.
GROUP_CHAT Gruppenunterhaltungen mit mindestens drei 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 im Thread antworten. Dadurch bleibt ihre Antwort im Kontext der ursprünglichen Nachricht.
GROUPED_MESSAGES Namensgruppenbereiche, in denen die Unterhaltung nach Thema organisiert ist. Themen und ihre Antworten werden gruppiert.
UNTHREADED_MESSAGES Direktnachrichten zwischen zwei Personen und Gruppenunterhaltungen mit mindestens drei 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. die Regeln, Erwartungen und Umgangsformen des Gruppenbereichs

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 aufbewahrt 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 Aufbewahrungsregeln für Google Vault der Organisation ist festgelegt, wie lange Nachrichten und Threads aufbewahrt werden.

MembershipCount

Die Anzahl der Mitgliedschaften in einem Gruppenbereich, gruppiert nach Kategorien.

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

integer

Nur Ausgabe. Anzahl der natürlichen Personen, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über eine Mitgliedschaft in einer verknüpften Gruppe beigetreten sind, werden nicht gezählt.
joinedGroupCount

integer

Nur Ausgabe. Die Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind.

AccessSettings

Die Zugriffseinstellung des Gruppenbereichs.

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.

Das Lesen der Zielgruppe unterstützt:

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

Für die Festlegung 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 eines Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die dem Gruppenbereich einzeln hinzugefügt oder eingeladen wurden, können ihn ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie unter Gruppenbereich für bestimmte Nutzer sichtbar machen.

Für das Erstellen von Gruppenbereichen mit offenem Zugang ist eine Nutzerauthentifizierung erforderlich.

PredefinedPermissionSettings

Vordefinierte Berechtigungseinstellungen, die Sie nur beim Erstellen eines benannten Gruppenbereichs angeben können. In Zukunft werden möglicherweise weitere Einstellungen 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 Berechtigungseinstellungen beim Erstellen eines Gruppenbereichs 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)

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

object (PermissionSetting)

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

object (PermissionSetting)

Optional. Einstellung zum Aktivieren und Deaktivieren des Gruppenbereichsverlaufs.
useAtMentionAll

object (PermissionSetting)

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

object (PermissionSetting)

Optional. Einstellung zum Verwalten von Apps in einem Gruppenbereich.
manageWebhooks

object (PermissionSetting)

Optional. Einstellung zum Verwalten von Webhooks in einem Gruppenbereich.
postMessages

object (PermissionSetting)

Nur Ausgabe. Einstellung für das Posten von Nachrichten in einem Gruppenbereich.
replyMessages

object (PermissionSetting)

Optional. 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

Optional. Ob Administratoren von Gruppenbereichen diese Berechtigung haben.
membersAllowed

boolean

Optional. Ob Mitglieder ohne die Rolle „Administrator“ diese Berechtigung haben.

Methoden

completeImport

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

create

 Erstellt einen Gruppenbereich.

delete

 Löscht einen benannten Gruppenbereich.

findDirectMessage

 Gibt die vorhandene Direktnachricht mit dem 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.
Gibt eine Liste der Gruppenbereiche in einer Google Workspace-Organisation zurück, die auf der Suche eines Administrators basiert.

setup

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