REST Resource: spaces.members

Ressource: Mitgliedschaft

Stellt eine Mitgliedschaftsbeziehung in Google Chat dar, z. B. ob ein Nutzer oder eine Chat-App zu einem Gruppenbereich eingeladen wurde, Teil eines Gruppenbereichs ist oder nicht.

JSON-Darstellung
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
Felder
name

string

ID. Der vom Server zugewiesene Ressourcenname der Mitgliedschaft.

Format: spaces/{space}/members/{member}

state

enum (MembershipState)

Nur Ausgabe. Status der Mitgliedschaft.

role

enum (MembershipRole)

Optional. Die Rolle des Nutzers in einem Chatbereich bestimmt, welche Aktionen er im Bereich ausführen darf.

Dieses Feld kann nur als Eingabe in members.patch verwendet werden.

createTime

string (Timestamp format)

Optional. Nicht veränderbar. Die Erstellungszeit der Mitgliedschaft, z. B. wann ein Mitglied einem Gruppenbereich beigetreten ist oder wann es eingeladen wurde, einem Gruppenbereich beizutreten. Dieses Feld dient nur der Ausgabe, außer wenn es zum Importieren von Mitgliedschaften aus der Vergangenheit in Gruppenbereiche im Importmodus verwendet wird.

deleteTime

string (Timestamp format)

Optional. Nicht veränderbar. Der Zeitpunkt, zu dem die Mitgliedschaft gelöscht wurde, z. B. wenn ein Mitglied einen Gruppenbereich verlassen oder daraus entfernt wurde. Dieses Feld dient nur der Ausgabe, außer wenn es zum Importieren von Mitgliedschaften aus der Vergangenheit in Gruppenbereiche im Importmodus verwendet wird.

affiliation

enum (Affiliation)

Nur Ausgabe. Die Beziehung eines Nutzers zur Workspace-Organisation, die Eigentümer des Bereichs ist. In Gruppenbereichen, die Privatnutzerkonten gehören, ist die Zugehörigkeit aller Mitglieder EXTERNAL.

Mitglied, das mit dieser Mitgliedschaft verknüpft ist. Möglicherweise werden in Zukunft weitere Mitgliedschaftstypen unterstützt. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
member

object (User)

Optional. Der Google Chat-Nutzer oder die Google Chat-App, zu der die Mitgliedschaft gehört. Wenn Ihre Chat-App als Nutzer authentifiziert wird, werden in der Ausgabe nur die Felder user name und type für interne und externe Nutzer ausgefüllt, es sei denn, sie sind Mitglieder des Gruppenbereichs oder haben eine frühere Beziehung zum aufrufenden Nutzer, z. B. eine Direktnachricht.

groupMember

object (Group)

Optional. Die Google-Gruppe, der die Mitgliedschaft entspricht.

Zum Lesen oder Ändern von Mitgliedschaften für Google-Gruppen ist eine Nutzerauthentifizierung erforderlich.

Ende der sich gegenseitig ausschließenden Felder.

MembershipState

Gibt die Beziehung des Mitglieds zu einem Space an. Möglicherweise werden in Zukunft weitere Mitgliedschaftsstatus unterstützt.

Enums
MEMBERSHIP_STATE_UNSPECIFIED Standardwert. Nicht verwenden.
JOINED Der Nutzer wird dem Gruppenbereich hinzugefügt und kann daran teilnehmen.
INVITED Der Nutzer wurde eingeladen, dem Gruppenbereich beizutreten, hat dies aber noch nicht getan.
NOT_A_MEMBER Der Nutzer gehört nicht zum Gruppenbereich und hat keine ausstehende Einladung, dem Gruppenbereich beizutreten.

MembershipRole

Stellt die zulässigen Aktionen eines Nutzers in einem Chatbereich dar. In Zukunft werden möglicherweise weitere Aufzählungswerte hinzugefügt.

Enums
MEMBERSHIP_ROLE_UNSPECIFIED Standardwert. Für users: Der Nutzer ist kein Mitglied des Gruppenbereichs, kann aber eingeladen werden. Für Google Groups: Diese Rolle wird immer zugewiesen (in Zukunft können andere Enumerationswerte verwendet werden).
ROLE_MEMBER

Ein Mitglied des Gruppenbereichs. In der Chat-Benutzeroberfläche wird diese Rolle als „Mitglied“ bezeichnet.

Der Nutzer hat grundlegende Berechtigungen, z. B. zum Senden von Nachrichten an den Gruppenbereich. Administratoren und Inhaber können Mitgliedern zusätzliche Berechtigungen in einem Gruppenbereich erteilen, z. B.:

  • Mitglieder hinzufügen oder entfernen
  • Details zum Gruppenbereich ändern
  • Aktivieren oder deaktivieren Sie den Verlauf.
  • Mit @all können Sie alle Personen im Gruppenbereich erwähnen.
  • Hier können Sie in einem Gruppenbereich installierte Chat-Apps und Webhooks verwalten.

In Direktnachrichten und unbenannten Gruppenunterhaltungen haben alle diese Rolle.

ROLE_MANAGER

Sie sind Inhaber des Gruppenbereichs. In der Chatbenutzeroberfläche heißt diese Rolle „Inhaber“.

Der Nutzer hat alle Berechtigungen für den Gruppenbereich, um ihn zu verwalten, einschließlich:

  • Ändern Sie die Rolle anderer Mitglieder im Gruppenbereich in „Mitglied“, „Administrator“ oder „Inhaber“.
  • Löschen Sie den Gruppenbereich.

Wird nur in SpaceType.SPACE (benannte Bereiche) unterstützt.

Weitere Informationen zur Rolle als Inhaber oder Administrator eines Gruppenbereichs

ROLE_ASSISTANT_MANAGER

Sie müssen Administrator des Gruppenbereichs sein. In der Chat-Benutzeroberfläche heißt diese Rolle „Administrator“.

Der Nutzer hat alle grundlegenden Berechtigungen von ROLE_MEMBER und kann von einem Inhaber eine Teilmenge der Administratorberechtigungen erhalten. Standardmäßig haben Administratoren alle Berechtigungen eines Inhabers, mit Ausnahme der folgenden:

  • Löschen Sie den Gruppenbereich.
  • Ein anderes Gruppenbereich-Mitglied zum Inhaber machen
  • Rolle eines Inhabers ändern

Standardmäßig haben Manager unter anderem folgende Berechtigungen:

  • Ein anderes Mitglied zum Administrator machen.
  • Nachrichten im Gruppenbereich löschen
  • Berechtigungen für Gruppenbereiche verwalten
  • Benachrichtigungen für Beitrittsanfragen für den Gruppenbereich erhalten, wenn der Administrator in den Einstellungen des Gruppenbereichs die Berechtigung „Mitglieder verwalten“ hat.
  • Gruppenbereich mit offenem Zugang erstellen

Wird nur in SpaceType.SPACE (benannte Bereiche) unterstützt.

Weitere Informationen

Gruppe

Eine Google-Gruppe in Google Chat.

JSON-Darstellung
{
  "name": string
}
Felder
name

string

Ressourcenname für eine Google-Gruppe.

Stellt eine Gruppe in der Cloud Identity Groups API dar.

Format: groups/{group}

Händler/Partner

Gibt die Zugehörigkeit eines Nutzers zur Google Workspace-Organisation an, die Eigentümer des Bereichs ist. Dieser Enum können in Zukunft weitere Werte hinzugefügt werden.

Enums
AFFILIATION_UNSPECIFIED Standardwert. Dieser Wert wird nicht verwendet.
INTERNAL Ein Konto, das von derselben Google Workspace-Organisation verwaltet wird, der der Gruppenbereich gehört.
EXTERNAL Ein Konto außerhalb der Google Workspace-Organisation, zu der der Gruppenbereich gehört, z.B. ein Privatnutzerkonto oder ein Konto, das von einer anderen Workspace-Organisation verwaltet wird.
MANAGED_EXTERNAL Ein Konto, das von der Workspace-Organisation verwaltet wird, der der Gruppenbereich gehört, aber für einen Nutzer bereitgestellt wurde, der nicht zur Organisation gehört (z.B. ein Gastnutzer). Weitere Informationen zu Gästen finden Sie unter https://support.google.com/chat/answer/16997417.

Methoden

create

Erstellt eine Mitgliedschaft für die aufrufende Chat-App, einen Nutzer oder eine Google-Gruppe.

delete

Löscht eine Mitgliedschaft.

get

Gibt Details zu einer Mitgliedschaft zurück.

list

Listet Mitgliedschaften in einem Gruppenbereich auf.

patch

Aktualisiert eine Mitgliedschaft.