- Ressource: Space
- Methoden
Ressource: Space
Ein Gruppenbereich in Google Chat. Gruppenbereiche sind Unterhaltungen zwischen zwei oder mehr Nutzern oder Direktnachrichten zwischen einem Nutzer und einer Chat-App.
| JSON-Darstellung |
|---|
{ "name": string, "type": enum ( |
| Felder | |
|---|---|
name |
ID. Ressourcenname des Space. Format: Dabei ist |
type |
Nur Ausgabe. Nicht mehr unterstützt: Verwenden Sie stattdessen |
spaceType |
Optional. Der Typ des Gruppenbereichs. Erforderlich, wenn ein Gruppenbereich erstellt oder der Typ eines Gruppenbereichs aktualisiert wird. Nur Ausgabe für andere Nutzung. |
singleUserBotDm |
Optional. Gibt an, ob der Gruppenbereich eine Direktnachricht zwischen einer Chat-App und einer einzelnen Person ist. |
threaded |
Nur Ausgabe. Nicht mehr unterstützt: Verwenden Sie stattdessen |
displayName |
Optional. Der Anzeigename des Space. Erforderlich, wenn Sie einen Space mit einem Bei Direktnachrichten ist dieses Feld möglicherweise leer. Unterstützt bis zu 128 Zeichen. |
externalUserAllowed |
Optional. Nicht veränderbar. Gibt an, ob in diesem Gruppenbereich alle Google Chat-Nutzer als Mitglieder zugelassen sind. Eingabe beim Erstellen eines Gruppenbereichs in einer Google Workspace-Organisation. Lassen Sie dieses Feld weg, wenn Sie Spaces unter den folgenden Bedingungen erstellen:
Bei vorhandenen Spaces dient dieses Feld nur der Ausgabe. |
spaceThreadingState |
Nur Ausgabe. Der Threading-Status im Chatbereich. |
spaceDetails |
Optional. Details zum Gruppenbereich, einschließlich Beschreibung und Regeln. |
spaceHistoryState |
Optional. Der Status des Nachrichtenverlaufs für Nachrichten und Threads in diesem Gruppenbereich. |
importMode |
Optional. Gibt an, ob dieser Gruppenbereich im Rahmen einer Datenmigration zu Google Workspace in Zum Erstellen eines Space in |
createTime |
Optional. Nicht veränderbar. Bei in Google Chat erstellten Gruppenbereichen: 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 für Spaces im Importmodus dieses Feld auf den historischen Zeitstempel fest, zu dem der Space in der Quelle erstellt wurde, um die ursprüngliche Erstellungszeit beizubehalten. Wird nur in der Ausgabe ausgefüllt, wenn |
lastActiveTime |
Nur Ausgabe. Zeitstempel der letzten Nachricht im Gruppenbereich. |
adminInstalled |
Nur Ausgabe. Bei Gruppenbereichen für Direktnachrichten (DM) mit einer Chat-App, ob der Gruppenbereich von einem Google Workspace-Administrator erstellt wurde. Administratoren können im Namen von Nutzern in ihrer Organisation eine Chat-App installieren und eine Direktnachricht mit ihr einrichten. Damit die Installation durch Administratoren unterstützt wird, muss Ihre Chat-App Direktnachrichten unterstützen. |
membershipCount |
Nur Ausgabe. Die Anzahl der beigetretenen Mitglieder, gruppiert nach Mitgliedstyp. Wird ausgefüllt, wenn |
accessSettings |
Optional. Gibt die Zugriffseinstellung des Gruppenbereichs an. Wird nur angegeben, wenn der |
spaceUri |
Nur Ausgabe. Der URI, über den ein Nutzer auf den Space zugreifen kann. |
sessionState |
Nur Ausgabe. Sitzungsstatus des Space. |
sessionEnableTime |
Nur Ausgabe. Zeitstempel, ab dem der Sitzungsunterstützungsstatus des Space unterstützt wird. Nicht festgelegt, wenn für den Space die Sitzungsunterstützung nicht aktiviert ist. |
importModeExpireTime |
Nur Ausgabe. Der Zeitpunkt, zu dem der Space automatisch vom System gelöscht wird, wenn er im Importmodus bleibt. Jeder im Importmodus erstellte Space muss diesen Modus vor Ablauf dieser Zeit mit Dieses Feld wird nur für Gruppenbereiche ausgefüllt, die im Importmodus erstellt wurden. |
customer |
Optional. Nicht veränderbar. Die Kundennummer der Domain des Gruppenbereichs. Nur erforderlich, wenn ein Space mit App-Authentifizierung erstellt wird und Im Format Dieses Feld wird nicht für Direktnachrichten (DMs) oder für Gruppenbereiche ausgefüllt, die von Nutzern erstellt wurden, die nicht Google Workspace verwenden. |
Stellt die Berechtigungseinstellungen eines Gruppenbereichs dar. Wird nur angegeben, wenn der space_type SPACE ist. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: |
|
predefinedPermissionSettings |
Optional. Nur Eingabe. Vordefinierte Einstellungen für Berechtigungen für Gruppenbereiche, die nur beim Erstellen eines Gruppenbereichs eingegeben werden können. Wenn das Feld nicht festgelegt ist, wird ein Bereich für die Zusammenarbeit erstellt. Nachdem Sie den Gruppenbereich erstellt haben, werden die Einstellungen im Feld Das Festlegen vordefinierter Berechtigungseinstellungen unterstützt:
|
permissionSettings |
Optional. Einstellungen für Berechtigungen für vorhandene Gruppenbereiche. Eingabe zum Aktualisieren der genauen Berechtigungseinstellungen für Gruppenbereiche, wobei vorhandene Berechtigungseinstellungen ersetzt werden. In der Ausgabe werden die aktuellen Berechtigungseinstellungen aufgeführt. Das Lesen und Aktualisieren von Berechtigungseinstellungen wird unterstützt für:
|
| Ende der sich gegenseitig ausschließenden Felder. | |
Typ
Nicht mehr unterstützt: Verwenden Sie stattdessen SpaceType.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Reserviert. |
ROOM |
Unterhaltungen zwischen zwei oder mehr Menschen. |
DM |
Direktnachricht zwischen einer Person und einer Chat-App, bei der alle Nachrichten flach sind. Direktnachrichten zwischen zwei Personen sind davon nicht betroffen. |
SpaceType
Der Typ des Gruppenbereichs. Erforderlich beim Erstellen oder Aktualisieren eines Space. Nur Ausgabe für andere Nutzung.
| 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 mindestens drei 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 |
Gruppenbereiche, die Nachrichten-Threads unterstützen. Wenn Nutzer auf eine Nachricht antworten, können sie im Thread antworten. So bleibt ihre Antwort im Kontext der ursprünglichen Nachricht. |
GROUPED_MESSAGES |
Benannte Gruppenbereiche, in denen die Unterhaltung nach Themen sortiert ist. Themen und die zugehörigen Antworten werden gruppiert. |
UNTHREADED_MESSAGES |
Gruppenbereiche, die keine Nachrichten-Threads unterstützen. Dieser Threading-Status für Gruppenbereiche wird nur in besonderen Fällen verwendet, z. B.:
|
SpaceDetails
Details zum Gruppenbereich, einschließlich Beschreibung und Regeln.
| JSON-Darstellung |
|---|
{ "description": string, "guidelines": string } |
| Felder | |
|---|---|
description |
Optional. Eine Beschreibung des Gruppenbereichs. Beschreiben Sie beispielsweise das Diskussionsthema, den funktionalen Zweck oder die Teilnehmer des Gruppenbereichs. Unterstützt bis zu 4.096 Zeichen. |
guidelines |
Optional. Die Regeln, Erwartungen und die Etikette des Gruppenbereichs. Unterstützt bis zu 5.000 Zeichen. |
HistoryState
Der Status des Verlaufs für Nachrichten und Gruppenbereiche. Gibt an, wie lange Nachrichten und Unterhaltungsthreads nach der Erstellung aufbewahrt werden.
| Enums | |
|---|---|
HISTORY_STATE_UNSPECIFIED |
Standardwert. Nicht verwenden. |
HISTORY_OFF |
Verlauf deaktiviert. Nachrichten und Threads 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
Stellt die Anzahl der Mitgliedschaften in einem Gruppenbereich dar, gruppiert nach Kategorien.
| JSON-Darstellung |
|---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
| Felder | |
|---|---|
joinedDirectHumanUserCount |
Nur Ausgabe. Anzahl der menschlichen Nutzer, die dem Gruppenbereich direkt beigetreten sind. Nutzer, die über eine Mitgliedschaft in einer Gruppe beigetreten sind, werden nicht berücksichtigt. |
joinedGroupCount |
Nur Ausgabe. Anzahl aller Gruppen, die dem Gruppenbereich direkt beigetreten sind. |
AccessSettings
Stellt die Zugriffseinstellung des Gruppenbereichs dar.
| JSON-Darstellung |
|---|
{ "accessState": enum ( |
| Felder | |
|---|---|
accessState |
Nur Ausgabe. Gibt den Zugriffsstatus des Space an. |
audience |
Optional. Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden, ihm beitreten und 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 auffindbar machen. Format: Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie Das Lesen der Zielgruppe unterstützt:
Dieses Feld wird nicht ausgefüllt, wenn der Bereich Zum Festlegen der Zielgruppe ist eine Nutzerauthentifizierung erforderlich. |
accessPermissionSettings |
Optional. Rufen Sie die Berechtigungseinstellungen für den Gruppenbereich auf. Wenn Sie die Zielgruppe beim Erstellen eines Gruppenbereichs festlegen möchten, geben Sie in Ihrer Anfrage das Feld |
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 dem Gruppenbereich einzeln hinzugefügt oder eingeladen wurden, können den Gruppenbereich ebenfalls finden und darauf zugreifen. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für bestimmte Nutzer auffindbar machen. Für das Erstellen von Gruppenbereichen mit offenem Zugang ist eine Nutzerauthentifizierung erforderlich. |
AccessPermissionSettings
Auf die Berechtigungseinstellungen für einen Gruppenbereich zugreifen
| JSON-Darstellung |
|---|
{ "discoverSpaceSetting": { object ( |
| Felder | |
|---|---|
discoverSpaceSetting |
Optional. Einstellung für die Zugriffsberechtigung zum Suchen des Gruppenbereichs. |
joinSpaceSetting |
Optional. Einstellung für die Zugriffsberechtigung zum Beitreten zum Gruppenbereich. |
viewSpaceMembershipSetting |
Optional. Zugriffsberechtigungseinstellung zum Aufrufen der Mitgliedschaft in einem Gruppenbereich. Muss zusammen mit |
AccessPermissionSetting
Eine Einstellung für die Zugriffsberechtigung.
| JSON-Darstellung |
|---|
{
"principals": [
{
object ( |
| Felder | |
|---|---|
principals[] |
Optional. Unsortierte Liste. Zulässige Hauptkonten für diese Berechtigung. |
Hauptkonto
Ein Hauptkonto, das eine Entität darstellt, der Zugriff gewährt wurde.
| JSON-Darstellung |
|---|
{
"audience": {
object ( |
| Felder | |
|---|---|
| Der Typ des Hauptkontos. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt: | |
audience |
Eine Zielgruppe. |
| Ende der sich gegenseitig ausschließenden Felder. | |
Zielgruppe
Eine Zielgruppe in Google Chat. Eine Zielgruppe ist eine Gruppe von Nutzern innerhalb einer Google Workspace-Organisation, die von einem Administrator definiert wird. Zielgruppen werden verwendet, um Zugriffs- und Sichtbarkeitseinstellungen für Ressourcen zu konfigurieren, z. B. um einen Gruppenbereich für eine bestimmte Nutzergruppe sichtbar zu machen.
Weitere Informationen finden Sie unter Zielgruppen und Gruppenbereiche für eine Zielgruppe auffindbar machen.
| JSON-Darstellung |
|---|
{ "name": string } |
| Felder | |
|---|---|
name |
Der Ressourcenname der Zielgruppe, die den Gruppenbereich finden oder ihm beitreten kann. Weitere Informationen finden Sie im Hilfeartikel Gruppenbereiche für eine Zielgruppe auffindbar machen. Format: Wenn Sie die Standardzielgruppe für die Google Workspace-Organisation verwenden möchten, legen Sie |
PredefinedPermissionSettings
Vordefinierte Berechtigungseinstellungen, die Sie nur beim Erstellen eines benannten Gruppenbereichs festlegen können. In Zukunft werden möglicherweise weitere Einstellungen hinzugefügt. Weitere Informationen zu den Berechtigungseinstellungen für benannte Gruppenbereiche finden Sie unter Informationen zu Gruppenbereichen.
| Enums | |
|---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Nicht angegeben Nicht verwenden. |
COLLABORATION_SPACE |
Einstellung, mit der der Gruppenbereich zu einem Bereich für die Zusammenarbeit wird, 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 Gruppenbereichs festlegen 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 ( |
| Felder | |
|---|---|
manageMembersAndGroups |
Optional. Einstellung zum Verwalten von Mitgliedern und Gruppen in einem Gruppenbereich. |
modifySpaceDetails |
Optional. Einstellung zum Aktualisieren des Namens, Avatars, der Beschreibung und der Richtlinien des Gruppenbereichs. |
toggleHistory |
Optional. Einstellung zum Aktivieren und Deaktivieren des Verlaufs für Gruppenbereiche. |
useAtMentionAll |
Optional. Einstellung für die Verwendung von @alle in einem Gruppenbereich. |
manageApps |
Optional. Einstellung zum Verwalten von Apps in einem Gruppenbereich. |
manageWebhooks |
Optional. Einstellung zum Verwalten von Webhooks in einem Gruppenbereich. |
postMessages |
Nur Ausgabe. Einstellung für das Posten von Nachrichten in einem Gruppenbereich. |
replyMessages |
Optional. Einstellung für das Antworten auf Nachrichten in einem Gruppenbereich. |
viewSpaceMembership |
Optional. Einstellung zum Ansehen der Mitgliedschaft in einem Gruppenbereich. Muss zusammen mit |
PermissionSetting
Stellt eine Berechtigungseinstellung für einen Gruppenbereich dar.
| JSON-Darstellung |
|---|
{ "managersAllowed": boolean, "membersAllowed": boolean, "assistantManagersAllowed": boolean } |
| Felder | |
|---|---|
managersAllowed |
Optional. Gibt an, ob Inhaber von Gruppenbereichen ( |
membersAllowed |
Optional. Gibt an, ob einfache Mitglieder des Gruppenbereichs ( |
assistantManagersAllowed |
Optional. Ob Administratoren von Gruppenbereichen ( |
SpaceSessionState
Sitzungsstatus des Space.
| Enums | |
|---|---|
SPACE_SESSION_STATE_UNSPECIFIED |
Nicht angegeben Nicht verwenden. |
NOT_SUPPORTED |
Der Space unterstützt keine Sitzungen. |
THREAD |
Der Space unterstützt sitzungsbasierte Threads. |
Methoden |
|
|---|---|
|
Schließt den Importvorgang für den angegebenen Gruppenbereich ab und macht ihn für Nutzer sichtbar. |
|
Erstellt einen Space. |
|
Löscht einen benannten Gruppenbereich. |
|
Gibt die vorhandene Direktnachricht mit dem angegebenen Nutzer zurück. |
|
Gibt alle Gruppenbereiche mit spaceType == GROUP_CHAT zurück, deren menschliche Mitglieder genau den aufrufenden Nutzer und die in FindGroupChatsRequest.users angegebenen Nutzer enthalten. |
|
Gibt Details zu einem Space zurück. |
|
Listet Gruppenbereiche auf, in denen der Aufrufer Mitglied ist. |
|
Aktualisiert einen Space. |
|
Gibt eine Liste der Spaces in einer Google Workspace-Organisation zurück. |
|
Erstellt einen Gruppenbereich und fügt ihm bestimmte Nutzer hinzu. |