REST Resource: spaces.members

Zasób: Membership

Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub aplikacja Google Chat jest zaproszona do pokoju, należy do niego czy jest w nim nieobecna.

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

  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
Pola
name

string

Identyfikator. Nazwa zasobu członkostwa przypisana przez serwer.

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

state

enum (MembershipState)

Tylko dane wyjściowe. Stan członkostwa.

role

enum (MembershipRole)

Opcjonalnie. Rola użytkownika w pokoju Google Chat, która określa, jakie działania może on wykonywać w tym pokoju.

To pole może być używane tylko jako dane wejściowe w members.patch.

createTime

string (Timestamp format)

Opcjonalnie. Wartość niezmienna. Czas utworzenia członkostwa, np. gdy użytkownik dołączył do pokoju lub został do niego zaproszony. To pole jest tylko danymi wyjściowymi, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.

deleteTime

string (Timestamp format)

Opcjonalnie. Wartość niezmienna. Czas usunięcia członkostwa, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest tylko danymi wyjściowymi, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.

affiliation

enum (Affiliation)

Tylko dane wyjściowe. Relacja użytkownika z organizacją Workspace, która jest właścicielem pokoju. W pokojach należących do kont konsumenckich przynależność wszystkich użytkowników to EXTERNAL.

Pole zbiorcze memberType. Użytkownik powiązany z tym członkostwem. W przyszłości mogą być obsługiwane inne typy użytkowników. memberType może mieć tylko jedną z tych wartości:
member

object (User)

Opcjonalnie. Użytkownik lub aplikacja Google Chat, do której odnosi się członkostwo. Jeśli aplikacja Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola użytkownika name i type.

groupMember

object (Group)

Opcjonalnie. Grupa dyskusyjna Google, do której odnosi się członkostwo.

Odczytywanie lub zmienianie członkostwa w grupach dyskusyjnych Google wymaga uwierzytelnienia użytkownika.

MembershipState

Określa relację użytkownika z pokojem. W przyszłości mogą być obsługiwane inne stany członkostwa.

Wartości w polu enum
MEMBERSHIP_STATE_UNSPECIFIED Wartość domyślna. Nie używaj.
JOINED Użytkownik został dodany do pokoju i może w nim uczestniczyć.
INVITED Użytkownik został zaproszony do dołączenia do pokoju, ale jeszcze tego nie zrobił.
NOT_A_MEMBER Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do dołączenia do niego.

MembershipRole

Reprezentuje działania, które użytkownik może wykonywać w pokoju Google Chat. W przyszłości możemy dodać więcej wartości w polu enum.

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. W przypadku users: użytkownik nie jest członkiem pokoju, ale można go zaprosić. W przypadku Google Groups: zawsze przypisywana jest ta rola (w przyszłości mogą być używane inne wartości w polu enum).
ROLE_MEMBER

Użytkownik pokoju. W interfejsie Google Chat ta rola nazywa się Użytkownik.

Użytkownik ma podstawowe uprawnienia, np. może wysyłać wiadomości do pokoju. Menedżerowie i właściciele mogą przyznawać użytkownikom dodatkowe uprawnienia w pokoju, w tym:

  • dodawanie i usuwanie użytkowników;
  • modyfikowanie szczegółów pokoju;
  • włączanie i wyłączanie historii;
  • wspominanie wszystkich osób w pokoju za pomocą @all;
  • zarządzanie aplikacjami Google Chat i webhookami zainstalowanymi w pokoju.

W przypadku czatów bezpośrednich i rozmów grupowych bez nazwy wszyscy mają tę rolę.

ROLE_MANAGER

Właściciel pokoju. W interfejsie Google Chat ta rola nazywa się Właściciel.

Użytkownik ma pełny zestaw uprawnień do zarządzania pokojem, w tym:

  • zmienianie roli innych użytkowników w pokoju na użytkownika, menedżera lub właściciela;
  • usuwanie pokoju.

Obsługiwane tylko w przypadku SpaceType.SPACE (nazwanych pokoi).

Więcej informacji znajdziesz w artykule Więcej informacji o roli właściciela lub menedżera pokoju.

ROLE_ASSISTANT_MANAGER

Menedżer pokoju. W interfejsie Google Chat ta rola nazywa się Menedżer.

Użytkownik ma wszystkie podstawowe uprawnienia ROLE_MEMBER i może otrzymać od właściciela podzbiór uprawnień administracyjnych. Domyślnie menedżerowie mają wszystkie uprawnienia właściciela oprócz możliwości:

  • usuwania pokoju;
  • przypisywania innej osobie z pokoju roli właściciela;
  • zmieniania roli właściciela.

Domyślnie uprawnienia menedżera obejmują m.in.:

  • przypisywanie innej osobie roli menedżera;
  • usuwanie wiadomości z pokoju;
  • zarządzanie uprawnieniami pokoju;
  • otrzymywanie powiadomień o prośbach o dołączenie do pokoju, jeśli menedżer ma uprawnienie „Zarządzaj użytkownikami” w ustawieniach pokoju;
  • ustawianie pokoju jako możliwego do znalezienia.

Obsługiwane tylko w przypadku SpaceType.SPACE (nazwanych pokoi).

Więcej informacji znajdziesz w artykule Zarządzanie ustawieniami pokoju.

Grupa

Grupa dyskusyjna Google w Google Chat.

Zapis JSON
{
  "name": string
}
Pola
name

string

Nazwa zasobu grupy dyskusyjnej Google.

Reprezentuje grupę w Cloud Identity Groups API.

Format: groups/{group}

Przynależność

Reprezentuje przynależność użytkownika do organizacji Google Workspace, która jest właścicielem pokoju. W przyszłości do tego pola enum mogą zostać dodane kolejne wartości.

Wartości w polu enum
AFFILIATION_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
INTERNAL Konto zarządzane przez tę samą organizację Google Workspace, która jest właścicielem pokoju.
EXTERNAL Konto zewnętrzne w stosunku do organizacji Google Workspace, która jest właścicielem pokoju (np. konto dla użytkowników indywidualnych lub konto zarządzane przez inną organizację Workspace).
MANAGED_EXTERNAL Konto zarządzane przez organizację Workspace, która jest właścicielem pokoju, ale udostępnione użytkownikowi spoza organizacji (np. gościowi). Więcej informacji o gościach znajdziesz na stronie https://support.google.com/chat/answer/16997417.

Metody

create

Tworzy członkostwo dla wywołującej aplikacji Google Chat, użytkownika lub grupy dyskusyjnej Google.

delete

Usuwa członkostwo.

get

Zwraca szczegóły członkostwa.

list

Wyświetla listę członkostw w pokoju.

patch

Aktualizuje członkostwo.