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,

  // Union field memberType can be only one of the following:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
  // End of list of possible types for union field memberType.
}
Felder
name

string

ID. Vom Server zugewiesener 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. Der Erstellungszeitpunkt 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 aus einem Gruppenbereich 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.

Union-Feld memberType. Mitglied, das mit dieser Mitgliedschaft verknüpft ist. Andere Mitgliedertypen werden möglicherweise in Zukunft unterstützt. Für memberType ist nur einer der folgenden Werte zulässig:
member

object (User)

Optional. Der Google Chat-Nutzer oder die Google Chat-App, der bzw. die der Mitgliedschaft entspricht. Wenn sich Ihre Chat-App als Nutzer authentifiziert, werden die user-Felder name und type mit der Ausgabe gefüllt.

groupMember

object (Group)

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

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

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, ist ihm aber noch nicht beigetreten.
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 Bereich. Administratoren und Inhaber können Mitgliedern zusätzliche Berechtigungen in einem Gruppenbereich erteilen, z. B.:

  • Mitglieder hinzufügen oder entfernen
  • Details zum Gruppenbereich ändern
  • Verlauf aktivieren und deaktivieren
  • Mit @all können Sie alle Personen im Gruppenbereich erwähnen.
  • Chat-Apps und Webhooks verwalten, die im Gruppenbereich installiert sind.

In Direktnachrichten und unbenannten Gruppenunterhaltungen hat jeder diese Rolle.

ROLE_MANAGER

Eigentümer des Gruppenbereichs In der Chat-Benutzeroberfläche wird diese Rolle als „Eigentümer“ bezeichnet.

Der Nutzer hat alle Space-Berechtigungen zum Verwalten des Space, einschließlich:

  • Ändern Sie die Rolle anderer Mitglieder im Gruppenbereich zu „Mitglied“, „Manager“ 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

Gruppe

Eine Google-Gruppe in Google Chat.

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

string

Der Ressourcenname einer Google-Gruppe.

Stellt eine Gruppe in der Cloud Identity Groups API dar.

Format: groups/{group}

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.