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,
  "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 Bereichs.

Format: spaces/{space}

Dabei steht {space} für die vom System zugewiesene ID für den Bereich. Sie können die Gruppenbereichs-ID abrufen, indem Sie die Methode spaces.list() aufrufen oder die Gruppenbereichs-URL verwenden. Wenn die URL des Bereichs beispielsweise https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA lautet, ist die Bereichs-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 beim Aktualisieren des Typs eines Gruppenbereichs. Nur Ausgabe für andere Verwendungszwecke.
singleUserBotDm

boolean

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

boolean

Nur Ausgabe. Verworfen: Verwenden Sie stattdessen spaceThreadingState. Ob Nachrichten in diesem Gruppenbereich in Threads organisiert sind.
displayName

string

Optional. Der Anzeigename des Bereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen und spaceType auf SPACE gesetzt ist. Wenn Sie beim Erstellen eines Gruppenbereichs oder beim Aktualisieren der displayName die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einer 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 jeder Google Chat-Nutzer Mitglied dieses Bereichs sein darf. Eingabe beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation. Lassen Sie dieses Feld beim Erstellen von Bereichen unter den folgenden Bedingungen weg:

  • Der authentifizierte Nutzer verwendet ein privates Konto (nicht verwaltetes Nutzerkonto). Standardmäßig ist in einem von einem privaten Konto erstellten Gruppenbereich jeder Google Chat-Nutzer zugelassen.

Bei vorhandenen Bereichen dient dieses Feld nur der Ausgabe.
spaceThreadingState

enum (SpaceThreadingState)

Nur Ausgabe. Der Status von 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 in Google Workspace erstellt wurde. 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 in Chat erstellten Gruppenbereichen ist das der Zeitpunkt, zu dem der Gruppenbereich erstellt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es in Gruppenbereichen im Importmodus verwendet wird.

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

Wird in der Ausgabe nur ausgefüllt, wenn spaceType GROUP_CHAT oder SPACE ist.
lastActiveTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich.
adminInstalled

boolean

Nur Ausgabe. Bei Direktnachrichtenbereichen (DMs) mit einer Chat-App wird angegeben, ob der Bereich 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 Ihre Chat-App Direktnachrichten unterstützen.
membershipCount

object (MembershipCount)

Nur Ausgabe. Die Anzahl der Mitgliedschaften, die abgeschlossen wurden, 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 der spaceType SPACE ist.
spaceUri

string

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

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der der Bereich automatisch vom System gelöscht wird, wenn er im Importmodus verbleibt.

Jeder im Importmodus erstellte Bereich muss diesen Modus vor Ablauf der Frist mit spaces.completeImport verlassen.

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 Projektbereich 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 ist. Bei privaten Apps kann auch der Alias customers/my_customer verwendet werden, um den Bereich in derselben Google Workspace-Organisation wie die App zu erstellen.

Bei DMs wird dieses Feld nicht ausgefüllt.
Union-Feld space_permission_settings. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn der space_type SPACE ist. 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 können. Wenn das Feld nicht festgelegt ist, wird ein Arbeitsbereich für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld PermissionSettings eingetragen.

Das Festlegen vordefinierter Berechtigungseinstellungen bietet folgende Vorteile:
permissionSettings

object (PermissionSettings)

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

Das Lesen und Aktualisieren von Berechtigungseinstellungen wird unterstützt für:

Typ

Verworfen: Verwenden Sie stattdessen SpaceType.

Enums
TYPE_UNSPECIFIED Reserviert.
ROOM Unterhaltungen zwischen zwei oder mehr Menschen.
DM 1:1-Direktnachricht zwischen einem Menschen und einer Chat-App, in der alle Nachrichten flach sind. Direktnachrichten zwischen zwei Personen sind davon nicht betroffen.

SpaceType

Der Typ des Gruppenbereichs. Erforderlich beim Erstellen oder Aktualisieren eines Projektbereichs. Nur Ausgabe für andere Verwendungszwecke.

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 Typ des Threading-Zustands im Chatbereich an.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Reserviert.
THREADED_MESSAGES Benannte Bereiche, die Nachrichten-Threads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie dies im Thread tun. So bleibt ihre Antwort im Kontext der ursprünglichen Nachricht.
GROUPED_MESSAGES Benannte Gruppenbereiche, in denen Unterhaltungen nach Thema sortiert sind. Themen und ihre Antworten werden gruppiert.
UNTHREADED_MESSAGES Direktnachrichten zwischen zwei Personen und Gruppenunterhaltungen zwischen 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. Beschreiben Sie beispielsweise das Diskussionsthema, den funktionalen Zweck oder die Teilnehmer des Bereichs.

Unterstützt bis zu 150 Zeichen.
guidelines

string

Optional. Regeln, Erwartungen und Verhaltensregeln für den Gruppenbereich.

Es können bis zu 5.000 Zeichen eingegeben werden.

HistoryState

Der Status des Verlaufs für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungs-Threads nach der Erstellung aufbewahrt werden.

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

MembershipCount

Stellt die Anzahl der Mitgliedschaften eines Bereichs dar, gruppiert nach Kategorien.

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

integer

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

integer

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

AccessSettings

Stellt die Zugriffseinstellung des Bereichs dar.

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

enum (AccessState)

Nur Ausgabe. Gibt den Zugriffsstatus des Bereichs an.
audience

string

Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden, ihm beitreten und die Nachrichten im Gruppenbereich als Vorschau ansehen kann. Wenn diese Option nicht festgelegt ist, können nur Nutzer oder Google-Gruppen auf den Gruppenbereich zugreifen, die einzeln eingeladen oder dem Gruppenbereich hinzugefügt wurden. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereich 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 Zielgruppe lesen:

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

Zum Festlegen der Zielgruppe ist eine Nutzerauthentifizierung erforderlich.

AccessState

Gibt den Zugriffsstatus des Gruppenbereichs an.

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

Der Administrator des Gruppenbereichs hat einer Zielgruppe Zugriff auf den Gruppenbereich gewährt. Nutzer oder Google-Gruppen, die dem Gruppenbereich einzeln hinzugefügt oder in den Gruppenbereich eingeladen wurden, können den Gruppenbereich auch finden und darauf zugreifen. Weitere Informationen finden Sie unter Projektbereich für bestimmte Nutzer auffindbar machen.

Zum 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 Bereiche finden Sie unter Bereiche.

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

PermissionSettings

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

Wenn Sie beim Erstellen eines Bereichs Berechtigungseinstellungen festlegen möchten, geben Sie das Feld PredefinedPermissionSettings in Ihrer Anfrage 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 Space.
modifySpaceDetails

object (PermissionSetting)

Optional. Einstellung zum Aktualisieren von Name, Avatar, Beschreibung und Richtlinien des 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 Bereich.
manageWebhooks

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Optional. Einstellung zum Antworten auf 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. Gibt an, ob Mitglieder, die keine Manager sind, 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 Bereich.

findDirectMessage

 Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück.

get

 Gibt Details zu einem Gruppenbereich zurück.

list

 Listet Projektbereiche auf, in denen der Aufrufer Mitglied ist.

patch

 Aktualisiert einen Gruppenbereich.
Gibt eine Liste von Bereichen in einer Google Workspace-Organisation basierend auf der Suche eines Administrators zurück.

setup

 Erstellt einen Bereich und fügt die angegebenen Nutzer hinzu.