REST Resource: spaces.members

Zasób: członkostwo

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

Zapis JSON
{
  "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)
  }
}
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 tym pokoju.

To pole może być używane jako dane wejściowe tylko 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 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: Wartość niezmienna. Czas usunięcia użytkownika, np. kiedy 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 pokój. W pokojach należących do kont konsumenckich przynależność wszystkich użytkowników jest oznaczona jako EXTERNAL.

Użytkownik powiązany z tym członkostwem. W przyszłości możemy obsługiwać inne typy 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 Google Chat uwierzytelnia się jako użytkownik, dane wyjściowe wypełniają tylko pola użytkownik name i type w przypadku użytkowników wewnętrznych i zewnętrznych, chyba że są oni członkami pokoju lub mają wcześniejsze powiązanie, np. rozmowę na czacie, z użytkownikiem wywołującym.

groupMember

object (Group)

Opcjonalnie: Grupa dyskusyjna 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 przypisywana jest im ta rola (w przyszłości mogą być używane inne wartości wyliczeniowe).
ROLE_MEMBER

osoba w pokoju; W interfejsie Google Chat ta rola jest nazywana Uczestnik.

Użytkownik ma podstawowe uprawnienia, np. 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 grupy;
  • modyfikować szczegóły pokoju,
  • włączanie i wyłączanie historii,
  • Dodaj wzmiankę o wszystkich osobach w pokoju za pomocą @all.
  • zarządzać aplikacjami Google Chat i webhookami zainstalowanymi w pokoju.

Na czatach i czatach grupowych bez nazwy wszyscy mają 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 użytkowników w pokoju na użytkownika, 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 Chat ta rola nosi nazwę Menedżer.

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

  • usunąć pokój.
  • Nadawanie innej osobie z pokoju roli właściciela.
  • Zmień rolę właściciela.

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

  • przypisywać innemu członkowi rolę 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 „zarządzaj użytkownikami” w ustawieniach pokoju;
  • Udostępnij pokój do znalezienia.

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, do której należy przestrzeń. 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 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 w aplikacji Google Chat do prowadzenia rozmów, użytkownika lub grupy Google.

delete

Usuwa subskrypcję.

get

Zwraca szczegóły subskrypcji.

list

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

patch

Aktualizuje subskrypcję.