REST Resource: spaces.members

Zasób: Membership

Reprezentuje relację członkostwa w Google Chat, np. czy użytkownik lub aplikacja do czatu 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 uczestnictwa przypisana przez serwer.

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

state

enum (MembershipState)

Tylko dane wyjściowe. Stan subskrypcji.

role

enum (MembershipRole)

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

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

createTime

string (Timestamp format)

Opcjonalnie: Niezmienne. Czas utworzenia członkostwa, np. gdy użytkownik dołączył do pokoju lub otrzymał zaproszenie do dołączenia do niego. To pole jest tylko polem wyjściowym, z wyjątkiem sytuacji, gdy jest używane do importowania historycznych członkostw w pokojach w trybie importowania.

deleteTime

string (Timestamp format)

Opcjonalnie: Niezmienne. Czas usunięcia członkostwa, np. gdy użytkownik opuścił pokój lub został z niego usunięty. To pole jest tylko polem wyjściowym, 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, do której należy miejsce. W pokojach należących do kont użytkowników indywidualnych przynależność wszystkich użytkowników to EXTERNAL.

Uczestnik powiązany z tym członkostwem. W przyszłości możemy wprowadzić obsługę innych typów członków. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
member

object (User)

Opcjonalnie: Użytkownik lub aplikacja Google Chat, do której należy członkostwo. Jeśli aplikacja do obsługi czatu uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają pola user nametype.

groupMember

object (Group)

Opcjonalnie: Grupa Google, do której należy członkostwo.

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

Koniec pól wykluczających się nawzajem.

MembershipState

Określa relację użytkownika z pokojem. W przyszłości możemy dodać obsługę innych krajów członkowskich.

Wartości w polu enum
MEMBERSHIP_STATE_UNSPECIFIED Wartość domyślna. Nie używaj.
JOINED Użytkownik zostanie dodany do pokoju i będzie mógł w nim uczestniczyć.
INVITED Użytkownik został zaproszony do pokoju, ale jeszcze do niego nie dołączył.
NOT_A_MEMBER Użytkownik nie należy do pokoju i nie ma oczekującego zaproszenia do dołączenia do niego.

MembershipRole

Określa dozwolone działania użytkownika w pokoju czatu. W przyszłości możemy dodać więcej wartości typu wyliczeniowego.

Wartości w polu enum
MEMBERSHIP_ROLE_UNSPECIFIED Wartość domyślna. users: nie jest użytkownikiem pokoju, ale można go zaprosić. W przypadku Google Groups: zawsze mają przypisaną tę rolę (w przyszłości mogą być używane inne wartości wyliczeniowe).
ROLE_MEMBER

osoba w pokoju; W interfejsie Chat ta rola jest nazywana Użytkownik.

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

  • dodawać i usuwać członków;
  • modyfikować szczegóły pokoju,
  • włączanie i wyłączanie historii,
  • Dodaj wzmiankę o wszystkich osobach w pokoju za pomocą @all.
  • zarządzać aplikacjami i webhookami Google Chat zainstalowanymi w pokoju.

Na czatach i czatach grupowych bez nazwy każda osoba ma tę rolę.

ROLE_MANAGER

właściciel pokoju, W interfejsie czatu ta rola jest nazywana właścicielem.

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

  • zmieniać rolę innych członków pokoju na członka, menedżera lub właściciela;
  • usunąć pokój.

Obsługiwane tylko w SpaceType.SPACE (nazwane pokoje).

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

ROLE_ASSISTANT_MANAGER

menedżerem pokoju, W interfejsie Google Chat ta rola nosi nazwę Menedżer.

Użytkownik ma wszystkie podstawowe uprawnienia ROLE_MEMBER, a właściciel może mu przyznać podzbiór uprawnień administracyjnych. Domyślnie menedżerowie mają wszystkie uprawnienia właściciela, ale nie mogą:

  • usunąć pokój.
  • nadawania innym członkom pokoju roli właściciela,
  • zmieniać rolę właściciela,

Uprawnienia menedżerów obejmują domyślnie m.in.:

  • nadawania innym członkom roli menedżera,
  • usuwać wiadomości w pokoju;
  • zarządzać uprawnieniami pokoju;
  • otrzymywać powiadomienia o prośbach o dołączenie do pokoju, jeśli menedżer ma uprawnienia do zarządzania użytkownikami w ustawieniach pokoju;
  • Udostępnij pokój.

Obsługiwane tylko w SpaceType.SPACE (nazwane pokoje).

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

Grupa

Grupy dyskusyjnej 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ść

Określa przynależność użytkownika do organizacji Google Workspace, która jest właścicielem miejsca. W przyszłości do tego wyliczenia 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 względem organizacji Google Workspace, która jest właścicielem pokoju (np. konto indywidualne 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 w aplikacji do połączeń w Google Chat, użytkownika lub grupy Google.

delete

Usuwa subskrypcję.

get

Zwraca szczegóły subskrypcji.

list

Wyświetla listę użytkowników pokoju.

patch

Aktualizuje subskrypcję.