Wyświetlenie listy pokoi (original) (raw)

Z tego przewodnika dowiesz się, jak używać metodylist()w zasobie Space interfejsu Google Chat API do wyświetlania listy pokoi. Wyświetlanie pokoi zwraca paginowaną listę pokoi, którą można filtrować.

SpaceZasóbreprezentuje miejsce, w którym użytkownicy i aplikacje do obsługi czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka rodzajów pokoi:

• Wiadomości na czacie to rozmowy między 2 użytkownikami lub między użytkownikiem a aplikacją do obsługi czatu.
• Czaty grupowe to rozmowy między co najmniej 3 użytkownikami a aplikacjami do czatowania.
• Pokoje z nazwami to trwałe miejsca, w których użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować.

Lista pokoi z uwierzytelnianiem aplikacji zawiera pokoje, do których aplikacja Google Chat ma dostęp. Wyświetlanie przestrzeni z uwierzytelnianiem użytkownikawyświetla listę przestrzeni, 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 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 Google Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie credentials.json.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.

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 Google Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie credentials.json.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.

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 Google Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie credentials.json.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja do obsługi czatu.

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 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ć się jako użytkownik, czy jako aplikacja do obsługi czatu.

Wyświetlanie listy przestrzeni z uwierzytelnianiem użytkownika

Aby wyświetlić listę pokoi w Google Chat, w żądaniu przekaż te informacje:

• W przypadku uwierzytelniania użytkownika określ zakres autoryzacji chat.spaces.readonly lub chat.spaces.
• Wywołaj metodę ListSpaces().

W tym przykładzie wymienione są pokoje z nazwami (ale nie czaty grupowe ani wiadomości bezpośrednie, które są odfiltrowane) widoczne dla uwierzytelnionego użytkownika:

Node.js

Python

Java

Google Apps Script

Interfejs Chat API zwraca stronicowaną listę pokoi.

Wystawianie przestrzeni z uwierzytelnianiem aplikacji

Aby wyświetlić listę pokoi w Google Chat, w żądaniu przekaż te informacje:

• W przypadku uwierzytelniania aplikacji określ zakres autoryzacji chat.bot.
• Wywołaj metodę ListSpaces().

Poniższy przykład zawiera listę nazwanych pokoi (ale nie czatów grupowych ani czatów), które są widoczne dla aplikacji Chat:

Node.js

Python

Java

Google Apps Script

Interfejs Chat API zwraca stronicowaną listę pokoi.

Aby wyświetlić listę pokoi w Google Chat, przekaż te opcjonalne parametry zapytania, aby dostosować stronicowanie lub filtrowanie wyświetlanych pokoi:

• pageSize: maksymalna liczba miejsc do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 miejsc. Maksymalna wartość to 1000. Wartości powyżej 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. Szczegółowe informacje o obsługiwanych zapytaniach znajdziesz w ListSpacesRequestmateriałach referencyjnych.
• Utwórz pokój.
• Skonfiguruj pokój
• Sprawdzanie szczegółów pokoju
• Aktualizowanie pokoju
• Usuń pokój.
• Znajdź pokój na czacie