Z tego przewodnika dowiesz się, jak używać metody list()
w zasobach SpaceEvent
interfejsu Google Chat API, aby wyświetlić zmiany w zasobach w pokoju.
SpaceEvent
Zasób reprezentuje zmianę w pokoju docelowym, w tym jego zasoby podrzędne, takie jak wiadomości, reakcje i członkostwa. Więcej informacji o liście obsługiwanych typów zdarzeń i ładunków zdarzeń znajdziesz w eventType
i payload
w dokumentacji referencyjnej zasobu SpaceEvent
.
Możesz wyświetlić zdarzenia z okresu do 28 dni przed datą wysłania żądania. Serwer zwraca zdarzenia zawierające najnowszą wersję danego zasobu.
Jeśli na przykład wyświetlasz listę zdarzeń dotyczących nowych członków pokoju, serwer zwraca zasoby Membership
zawierające najnowsze informacje o członkostwie. Jeśli w okresie objętym prośbą o raport usunięto nowych członków, ładunek zdarzenia zawiera pusty zasób Membership
.
Aby wywołać tę metodę, musisz użyć uwierzytelniania użytkownika. Aby wyświetlić listę wydarzeń z pokoju, uwierzytelniony użytkownik musi być użytkownikiem tego pokoju.
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 identyfikator klienta OAuth dla aplikacji komputerowej. Aby uruchomić przykładowy skrypt w tym przewodniku, zapisz dane logowania jako plik JSON o nazwie
client_secrets.json
w katalogu lokalnym.
- Wybierz zakres autoryzacji, który obsługuje uwierzytelnianie użytkowników.
Lista zdarzeń w pokoju
Aby wyświetlić listę zdarzeń pokoju z Google Chat, w żądaniu podaj te informacje:
Określ co najmniej 1 zakres autoryzacji, aby obsługiwać w prośbie każdy typ zdarzenia. Zalecamy wybranie najbardziej ograniczonego zakresu, który nadal umożliwia działanie aplikacji. Aby wybrać zakres, zapoznaj się z artykułem Omówienie uwierzytelniania i autoryzacji.
Wywołaj metodę
ListSpaceEvents()
, przekazując do niej listę typów zdarzeńfilter
. Musisz określić co najmniej 1 typ zdarzenia. Możesz też filtrować według daty. Listę obsługiwanych typów zdarzeń znajdziesz w polueventType
w dokumentacji referencyjnej zasobuSpaceEvent
.
W tym przykładzie wymienione są zdarzenia dotyczące nowych członkostw i wiadomości w pokoju:
Node.js
Aby uruchomić ten przykład, zastąp SPACE_NAME
identyfikatorem name
konta.
Identyfikator możesz uzyskać, wywołując metodę ListSpaces()
lub korzystając z adresu URL pokoju.
Interfejs API czatu zwraca listę zdarzeń w pokojach pogrupowanych na strony, która zawiera informacje o nowych członkach i wiadomościach.