Z tego przewodnika dowiesz się, jak używać metody list()
w zasobach Space
interfejsu Google Chat API, aby wyświetlić listę pokoi. Listing
spaces zwraca posortowaną listę pokoi, którą można filtrować.
Space
Zasób to miejsce, w którym użytkownicy i aplikacje czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka typów pokoi:
- Czaty to rozmowy między dwoma użytkownikami lub użytkownikiem a aplikacją czatu.
- Czaty grupowe to rozmowy między 3 lub większą liczbą użytkowników i aplikacji Google Chat.
- Nazwane pokoje to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.
Wyświetlanie pokoi z uwierzytelnianiem w aplikacji wyświetla listę pokoi, do których aplikacja Google Chat ma dostęp. Wyświetlanie spaces z Uwierzytelnianie użytkownika wyświetla pokoje, do których uwierzytelniony użytkownik ma dostęp.
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.
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.
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.
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ę Google Chat.
- 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.
Wyświetlanie czatu z uwierzytelnianiem użytkowników
Aby wyświetlić listę pokoi w Google Chat, w żądaniu podaj:
- W przypadku uwierzytelniania użytkownika określ zakres autoryzacji
chat.spaces.readonly
lubchat.spaces
. - Wywołaj metodę
ListSpaces()
.
W tym przykładzie wymieniono nazwane pokoje (ale nie czaty grupowe ani wiadomości bezpośrednie, które są filtrowane) widoczne dla uwierzytelnionego użytkownika:
Node.js
Python
Java
Google Apps Script
Interfejs Chat API zwraca listę pokoi podzieloną na strony.
Wyświetlanie pokoi z uwierzytelnianiem w aplikacji
Aby wyświetlić listę pokoi w Google Chat, w żądaniu podaj:
- W przypadku aplikacji uwierzytelniającej określ zakres autoryzacji
chat.bot
. - Wywołaj metodę
ListSpaces()
.
W tym przykładzie wymieniono nazwane pokoje (ale nie czaty grupowe ani bezpośrednie) widoczne w aplikacji Google Chat:
Node.js
Python
Java
Google Apps Script
Interfejs Chat API zwraca listę pokoi podzieloną na strony.
Dostosowywanie podziału na strony lub filtrowanie listy
Aby wyświetlić listę pokoi w Google Chat, prześlij te opcjonalne parametry zapytania, aby dostosować podział na strony lub filtrować wyświetlane pokoje:
pageSize
: maksymalna liczba miejsc do zwrócenia. Usługa może zwrócić mniej niż tę wartość. Jeśli nie zostanie podany, zwracane jest maksymalnie 100 miejsc. Maksymalna wartość to 1000; wartości wyższe 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. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w dokumentacjiListSpacesRequest
.
Powiązane artykuły
- Utwórz pokój.
- Skonfiguruj pokój.
- Znajdowanie informacji o pokoju
- Zaktualizuj pokój.
- Usuwanie pokoju.
- Znajdź pokój na czacie.