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,

  // 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}
type
(deprecated)

enum (Type)

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

enum (SpaceType)

Die Art des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen oder den Typ eines Gruppenbereichs aktualisieren. Ausgabe nur für andere Zwecke.
singleUserBotDm

boolean

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

boolean

Nur Ausgabe. Eingestellt: Verwende stattdessen spaceThreadingState. Gibt an, ob Nachrichten in diesem Gruppenbereich als Thread gespeichert sind.
displayName

string

Der Anzeigename des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen. Wenn Sie beim Erstellen eines Gruppenbereichs oder beim Aktualisieren von displayName die Fehlermeldung ALREADY_EXISTS erhalten, versuchen Sie es mit einem anderen displayName. Dieser Anzeigename wird möglicherweise bereits für einen bestehenden 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 für diesen Gruppenbereich alle Google Chat-Nutzer als Mitglied zugelassen 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 kann jeder Google Chat-Nutzer in einem Gruppenbereich, der von einem Privatnutzerkonto erstellt wurde, die Berechtigung erteilen.

  • Der Gruppenbereich wird für den Import von Daten in Google Chat verwendet, da Gruppenbereiche im Importmodus nur Mitglieder aus derselben Google Workspace-Organisation zulassen dürfen. Im Rahmen des Google Workspace-Entwicklervorschauprogramms können Gruppenbereiche im Importmodus jedoch jedem Google Chat-Nutzer erlauben, dieses Feld dann für Gruppenbereiche im Importmodus festzulegen.

Für vorhandene Gruppenbereiche wird dieses Feld nur für die Ausgabe verwendet.
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 in Import Mode im Rahmen einer Datenmigration zu Google Workspace erstellt wird. Während des Imports von Gruppenbereichen sind sie für Nutzer erst sichtbar, wenn der Import abgeschlossen ist.
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 wird nur für die Ausgabe verwendet, es sei denn, es wird in Bereichen im Importmodus verwendet.

Legen Sie für Gruppenbereiche im Importmodus für dieses Feld den historischen 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 verbundenen 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 des Gruppenbereichs.

Union-Feld space_permission_settings. Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur ausgefüllt, wenn space_type den Wert SPACE hat. Für space_permission_settings ist nur einer der folgenden Werte zulässig:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Optional. Nur Eingabe Berechtigungseinstellungen für den Gruppenbereich. Eingabe zum Erstellen eines Gruppenbereichs. Wenn dieses Feld nicht festgelegt ist, wird ein Gruppenbereich für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld PermissionSettings vorgenommen.

permissionSettings

object (PermissionSettings)

Optional. Genaue Berechtigungseinstellungen, die zum Aktualisieren des Gruppenbereichs festgelegt werden können. Eingabe zum Aktualisieren eines Gruppenbereichs. Andernfalls wird nur die Ausgabe ausgegeben. Verwenden Sie zum Erstellen des Gruppenbereichs stattdessen predefinedPermissionSettings.

Typ

Eingestellt: Verwende stattdessen SpaceType.

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

Die Art des Gruppenbereichs. Erforderlich, wenn Sie einen Gruppenbereich erstellen oder aktualisieren. Ausgabe nur für andere Zwecke.

Enums
SPACE_TYPE_UNSPECIFIED Reserviert.
SPACE Ein Ort, an dem Nutzer Nachrichten senden, Dateien freigeben und mit anderen zusammenarbeiten. Ein SPACE kann Chat-Apps enthalten.
GROUP_CHAT Gruppenunterhaltungen mit drei oder mehr Personen. Ein 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-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 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 einer 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 Teilnehmenden des Gruppenbereichs.

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 Threads werden 24 Stunden lang gespeichert.
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 auf den Gruppenbereich zugreifen kann. Legen Sie für dieses Feld eine gültige Zielgruppen-ID fest, damit der Gruppenbereich gefunden werden kann, oder verwenden Sie den Alias „audiences/default“, um den Gruppenbereich mit der standardmäßigen Zugriffseinstellung in der Admin-Konsole festzulegen. Weitere Informationen finden Sie unter Gruppenbereiche für eine Zielgruppe sichtbar machen. Entfernen Sie das Häkchen für dieses Feld, um den Gruppenbereich einzuschränken. Das Feld wird nur ausgefüllt, wenn der Gruppenbereich sichtbar ist. Format: audiences/{audience}, audiences/default kann als Alias der standardmäßigen Freigabeeinstellung für Google Chat verwendet werden.

AccessState

Stellt den Zugriffsstatus des Bereichs 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.

PredefinedPermissionSettings

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

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, um einen Gruppenbereich für Ankündigungen zu erstellen, in dem nur Administratoren des Gruppenbereichs Nachrichten posten können.

PermissionSettings

Berechtigungseinstellungen für einen benannten Gruppenbereich. 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 zum Beantworten von Nachrichten in einem Gruppenbereich.

PermissionSetting

Stellt eine Berechtigungseinstellung für den Gruppenbereich dar.

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

boolean

Ob Administratoren des Gruppenbereichs 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 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 Aufrufer Mitglied ist.

patch

 Aktualisiert einen Gruppenbereich.

setup

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