Z tego przewodnika dowiesz się, jak używać metody
list()
w zasobie Membership
Google Chat API, aby wyświetlać listę uczestników pokoju w formie podzielonej na strony, filtrowanej listy subskrypcji w pokoju.
- Lista subskrypcji z uwierzytelnianiem aplikacji zawiera subskrypcje w pokojach, do których aplikacja Google Chat ma dostęp, ale wyklucza subskrypcje aplikacji Google Chat, w tym własne.
- Wymienianie członkostw z uwierzytelnianiem użytkownika wymienia członkostwa w przestrzeniach, do których ma dostęp uwierzytelniony użytkownik.
- Wyświetlanie członkostwa jako administrator Google Workspace z uwierzytelnianiem użytkownika za pomocą uprawnień administratora powoduje wyświetlenie członkostwa we wszystkich pokojach w organizacji Google Workspace.
Membership
Zasób określa, czy użytkownik lub aplikacja Google Chat jest zaproszony do pokoju, należy do niego czy nie.
Wymagania wstępne
Node.js
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Zainstaluj bibliotekę klienta Cloud Node.js.
- Utwórz dane logowania, które będą zależeć od sposobu uwierzytelniania w żądaniu do interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
credentials.json
w katalogu lokalnym. - Aby uwierzytelnić się jako aplikacja w Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Python
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Zainstaluj bibliotekę klienta Cloud w Pythonie.
- Utwórz dane logowania, które będą zależeć od sposobu uwierzytelniania w żądaniu do interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
credentials.json
w katalogu lokalnym. - Aby uwierzytelnić się jako aplikacja w Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Java
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Zainstaluj bibliotekę klienta Cloud w języku Java.
- Utwórz dane logowania, które będą zależeć od sposobu uwierzytelniania w żądaniu do interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
credentials.json
w katalogu lokalnym. - Aby uwierzytelnić się jako aplikacja w Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik Chatu, utwórz dane logowania identyfikatora klienta OAuth i zapisz je jako plik JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Google Apps Script
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do obsługi czatu.
- Utwórz samodzielny projekt Apps Script i włącz zaawansowaną usługę czatu.
- W tym przewodniku musisz użyć uwierzytelniania użytkownika lub aplikacji. Aby uwierzytelnić się jako aplikacja do obsługi czatu, utwórz dane logowania konta usługi. Instrukcje znajdziesz w artykule Uwierzytelnianie i autoryzowanie jako aplikacja Google Chat.
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.
- Pokój Google Chat, w którym uwierzytelniony użytkownik lub wywołująca aplikacja Chat jest członkiem. Aby uwierzytelnić się jako aplikacja do czatu, dodaj ją do pokoju.
Wyświetlanie listy członków pokoju z uwierzytelnianiem użytkownika
Aby wyświetlić listę użytkowników, grup Google i aplikacji do obsługi czatu w przestrzeni, do której uwierzytelniony użytkownik ma dostęp, w żądaniu przekaż te informacje:
- W przypadku uwierzytelniania użytkownika określ zakres autoryzacji
chat.memberships.readonly
lubchat.memberships
. - Wywołaj metodę
ListMemberships()
. - Aby wyświetlić listę grup Google, ustaw parametr zapytania
showGroups
natrue
.
Poniższy przykład zawiera listę członków grup dyskusyjnych Google, osób i aplikacji widocznych dla uwierzytelnionego użytkownika.
Node.js
Python
Java
Google Apps Script
Aby uruchomić ten przykład, zastąp SPACE_NAME
identyfikatorem z pola name
przestrzeni. Możesz go uzyskać, wywołując metodę
ListSpaces()
lub z adresu URL pokoju.
Interfejs Google Chat API zwraca listę członków grupy Google, osób i aplikacji z określonego pokoju.
Wyświetlanie listy członków w pokoju z uwierzytelnianiem aplikacji
Aby wyświetlić listę użytkowników i aplikacji Google Chat w pokoju, do którego uwierzytelniona aplikacja ma dostęp, w żądaniu przekaż te informacje:
- W przypadku uwierzytelniania aplikacji określ zakres autoryzacji
chat.bot
. - Wywołaj metodę
ListMemberships()
. - Aby wyświetlić listę grup Google, ustaw parametr zapytania
showGroups
natrue
.
Poniższy przykład zawiera listę użytkowników pokoju (nie menedżerów pokoju) widocznych dla aplikacji Chat:
Node.js
Python
Java
Google Apps Script
Aby uruchomić ten przykład, zastąp SPACE_NAME
identyfikatorem z pola name
przestrzeni. Możesz go uzyskać, wywołując metodę
ListSpaces()
lub z adresu URL pokoju.
Interfejs Google Chat API zwraca listę użytkowników pokoju (z wyłączeniem menedżerów pokoju) z określonego pokoju.
Wyświetlanie członków listy jako administrator Google Workspace
Jeśli jesteś administratorem Google Workspace, możesz wywołać metodę ListMemberships()
, aby wyświetlić listę członkostw w dowolnym pokoju w organizacji Google Workspace. Interfejs Chat API zwraca tylko informacje o członkostwie użytkowników (zarówno wewnętrznych, jak i zewnętrznych) lub grup Google z Twojej organizacji, a tym samym pomija informacje o członkostwie w przypadku aplikacji Google Chat.
Aby wywołać tę metodę jako administrator Google Workspace:
- Wywołaj metodę za pomocą uwierzytelniania użytkownika i określ zakres autoryzacji, który obsługuje wywoływanie metody z użyciem uprawnień administratora.
- W żądaniu podaj te parametry zapytania:
- Ustaw wartość
useAdminAccess
natrue
. - Aby zwrócić tylko użytkowników, ustaw wartość
filter
dlamember.type
naHUMAN
. - Aby zwrócić użytkowników i grupy, ustaw
filter
dlamember.type
nie jest równeBOT
AND
showGroups
jest równetrue
.
- Ustaw wartość
Więcej informacji i przykłady znajdziesz w artykule Zarządzanie pokojami w Google Chat jako administrator Google Workspace.
Dostosowywanie paginacji lub filtrowanie listy
Aby wyświetlić listę subskrypcji, przekaż te parametry zapytania, aby dostosować paginację lub filtrować wyświetlane subskrypcje:
pageSize
: maksymalna liczba subskrypcji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określisz tu żadnej wartości, zwracanych będzie maksymalnie 100 przestrzeni. Wartość maksymalna to 1000. Wartości większe niż 1000 są automatycznie zmieniane na 1000.pageToken
: token strony otrzymany z poprzedniego wywołania listy miejsc. Podaj ten token, aby pobrać następną stronę. Podczas paginacji wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazanie innej wartości może prowadzić do nieoczekiwanych wyników.filter
: filtr zapytania. Wymaga uwierzytelnienia użytkownika. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz wListMembershipsRequest
.
Powiązane artykuły
- Uzyskiwanie szczegółowych informacji o członkostwie użytkownika lub aplikacji na czacie
- Zapraszanie lub dodawanie użytkownika lub aplikacji Google Chat do pokoju
- Aktualizowanie członkostwa użytkownika w pokoju Google Chat
- Usuwanie użytkownika lub aplikacji do obsługi czatu z pokoju