Z tego przewodnika dowiesz się, jak użyć metody list()
w zasobach Membership
interfejsu Google Chat API, aby wyświetlić listę użytkowników pokoju w postaci ponumerowanych i możliwych do odfiltrowania list członków pokoju.
- Wyświetlanie członkostwa z autoryzacją aplikacji wyświetla członkostwo w pokojach, do których ma dostęp aplikacja Google Chat, ale wyklucza członkostwo w aplikacji Google Chat, w tym w samej aplikacji.
- Wyświetlanie członkostwa z uwierzytelnieniem użytkownikawyświetla członkostwo w pokojach, do których uwierzytelniony użytkownik ma dostęp.
- Wyświetlanie członkostwa jako administrator Google Workspace z uwierzytelnieniem użytkownika za pomocą uprawnień administratorawyświetla członkostwo we wszystkich pokojach w organizacji Google Workspace.
Membership
Zasób wskazuje, czy użytkownik lub aplikacja Google Chat zostali zaproszeni do pokoju, czy są w nim obecni, czy też są z niego wykluczeni.
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 dla Node.js.
- Utwórz poświadczenia dostępu na podstawie sposobu uwierzytelniania w żądaniu interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik czatu, utwórz dane logowania OAuth z identyfikatorem klienta i zapisz je w katalogu lokalnym w pliku JSON o nazwie
client_secrets.json
. - Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania do konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik czatu, utwórz dane logowania OAuth z identyfikatorem klienta i zapisz je w katalogu lokalnym w pliku JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić użytkownika czy aplikację Google Chat.
- Pokój Google Chat, którego użytkownik uwierzytelniony lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja Google Chat, 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 poświadczenia dostępu na podstawie sposobu uwierzytelniania w żądaniu interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik czatu, utwórz dane logowania OAuth z identyfikatorem klienta i zapisz je w katalogu lokalnym w pliku JSON o nazwie
client_secrets.json
. - Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania do konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik czatu, utwórz dane logowania OAuth z identyfikatorem klienta i zapisz je w katalogu lokalnym w pliku JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić użytkownika czy aplikację Google Chat.
- Pokój Google Chat, którego użytkownik uwierzytelniony lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja Google Chat, 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 Javie.
- Utwórz poświadczenia dostępu na podstawie sposobu uwierzytelniania w żądaniu interfejsu Google Chat API:
- Aby uwierzytelnić się jako użytkownik czatu, utwórz dane logowania OAuth z identyfikatorem klienta i zapisz je w katalogu lokalnym w pliku JSON o nazwie
client_secrets.json
. - Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania do konta usługi i zapisz je w pliku JSON o nazwie
credentials.json
.
- Aby uwierzytelnić się jako użytkownik czatu, utwórz dane logowania OAuth z identyfikatorem klienta i zapisz je w katalogu lokalnym w pliku JSON o nazwie
- Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić użytkownika czy aplikację Google Chat.
- Pokój Google Chat, którego użytkownik uwierzytelniony lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja Google Chat, 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 Google Chat, 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ć użytkownika czy aplikację Google Chat.
- Pokój Google Chat, którego użytkownik uwierzytelniony lub wywołująca aplikacja Google Chat jest członkiem. Aby uwierzytelnić się jako aplikacja Google Chat, dodaj ją do pokoju.
Wyświetlanie listy członków w pokoju z uwierzytelnianiem użytkowników
Aby wyświetlić listę użytkowników, Grup dyskusyjnych Google i aplikacji Google Chat w przestrzeni, do której zalogowany użytkownik ma dostęp, prześlij w żądaniu te informacje:
- W przypadku uwierzytelniania użytkownika określ zakres uprawnień
chat.memberships.readonly
lubchat.memberships
. - Wywołaj metodę
ListMemberships()
. - Aby wyświetlić listę grup Google, ustaw parametr zapytania
showGroups
natrue
.
W tym przykładzie wymienione są osoby i użytkownicy aplikacji oraz grupy dyskusyjne Google widoczne dla uwierzytelnionego użytkownika.
Node.js
Python
Java
Google Apps Script
Aby uruchomić ten przykład, zastąp wartość SPACE_NAME
identyfikatorem z pola name
w pokoju. Identyfikator możesz uzyskać, wywołując metodę ListSpaces()
lub korzystając z adresu URL pokoju.
Interfejs Google Chat API zwraca listę użytkowników Google Groups, ludzi i aplikacji w określonym pokoju.
Wyświetlanie listy członków w pokoju z uwierzytelnianiem za pomocą aplikacji
Aby wyświetlić listę użytkowników i aplikacji Google Chat w pokoju, do którego uwierzytelniona aplikacja ma dostęp, prześlij w żądaniu te informacje:
- W przypadku aplikacji uwierzytelniającej określ zakres autoryzacji
chat.bot
. - Wywołaj metodę
ListMemberships()
. - Aby wyświetlić listę grup Google, ustaw parametr zapytania
showGroups
natrue
.
W tym przykładzie wymienione są osoby (nie menedżerowie pokoju) widoczne dla aplikacji Google Chat:
Node.js
Python
Java
Google Apps Script
Aby uruchomić ten przykład, zastąp wartość SPACE_NAME
identyfikatorem z pola name
w pokoju. Identyfikator możesz uzyskać, wywołując metodę ListSpaces()
lub z adresu URL pokoju.
Interfejs API Google Chat zwraca listę użytkowników pokoju (z wyłączeniem menedżerów pokoju) z określonego pokoju.
Dodawanie użytkowników jako administratora Google Workspace
Jeśli jesteś administratorem Google Workspace, możesz wywołać metodę ListMemberships()
, aby wyświetlić listę członków dowolnego pokoju w organizacji Google Workspace. Interfejs API Google Chat zwraca tylko informacje o uczestnictwie użytkowników (zarówno wewnętrznych, jak i zewnętrznych) oraz grup Google w Twojej organizacji, dlatego pomija informacje o uczestnictwie w dowolnych aplikacjach Google Chat.
Aby wywołać tę metodę jako administrator Google Workspace:
- Wywołaj metodę, używając uwierzytelniania użytkownika, i określ zakres autoryzacji, który obsługuje wywoływanie metody za pomocą uprawnień administratora.
- W żądaniu podaj te parametry zapytania:
- Ustaw
useAdminAccess
natrue
. - Aby zwrócić tylko użytkowników, ustaw wartość parametru
filter
w elemenciemember.type
naHUMAN
. - Aby zwrócić użytkowników i grupy, ustaw
filter
dlamember.type
jako nierówneBOT
AND
showGroups
jako równetrue
.
- Ustaw
Więcej informacji i przykłady znajdziesz w artykule Zarządzanie pokojami Google Chat przez administratora Google Workspace.
Dostosowywanie podziału na strony lub filtrowanie listy
Aby wyświetlić listę członkostw, prześlij te parametry zapytania, aby dostosować podział na strony lub filtrować wymienione członkostwa:
pageSize
: maksymalna liczba subskrypcji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie podana, zwróci maksymalnie 100 spacji. Maksymalna wartość to 1000. Wartości większe niż 1000 są automatycznie zmieniane na 1000.pageToken
: token strony otrzymany z poprzedniego wywołania listy. Podaj ten token, aby pobrać kolejną stronę. Podczas podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Podanie innej wartości może spowodować nieoczekiwane wyniki.filter
: filtr zapytania. Wymaga uwierzytelniania użytkownika. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w dokumentacjiListMembershipsRequest
.
Powiązane artykuły
- Dowiedz się więcej o subskrypcji użytkownika lub aplikacji Google Chat
- Zapraszanie użytkownika lub aplikacji Google Chat do pokoju
- Aktualizowanie członkostwa użytkownika w pokoju Google Chat
- Usuwanie użytkownika lub aplikacji Google Chat z pokoju.