Praca z wydarzeniami z Google Chat

Na tej stronie wyjaśniamy, jak aplikacje Google Chat mogą otrzymywać wiadomości i na nie reagować wydarzenia w Google Chat.

Zdarzenie w Google Chat reprezentuje aktywność lub zmianę w Google Chat. np. nowej wiadomości w pokoju. Aplikacja Google Chat może używać zdarzenia, aby zrozumieć, co się stało, i podjąć działania lub zareagować w znaczący sposób dla użytkowników.

Oto kilka przykładów użycia zdarzeń:

  • Monitorowanie nowych wiadomości i odpowiadanie na nie w pokoju, na przykład sprawdzanie kluczy słowa lub wyrażenia.
  • Aby wyjaśnić pokój, wyślij wiadomość powitalną do użytkowników, którzy dołączają do pokoju. lub radzimy, jak skutecznie korzystać aplikacja Google Chat.
  • Śledź i analizuj aktywność w Google Chat. Aby na przykład wysłać comiesięczny raport na temat nowych wspierających lub wiadomości, reakcji lub odpowiedzi.
  • Komunikacja między platformami komunikacyjnymi Użytkownicy mogą na przykład wysłać i otrzymywać wiadomości od użytkowników na innej platformie komunikacyjnej bez wychodzenia z czatu.

Jak działają wydarzenia

Gdy coś się dzieje w Google Chat, zasób interfejsu Google Chat API jest utworzonych, zaktualizowanych lub usuniętych. Google Chat używa zdarzeń do dostarczania wysyłane do aplikacji Google Chat informacje o typie która wystąpiła, i wskaż zasób interfejsu Chat API, którego to dotyczy.

Przykład sposobu, w jaki wiadomość opublikowana w pokoju Google Chat wyzwala zdarzenie.
Rysunek 1. Użytkownik publikuje wiadomość w pokój czatu, który tworzy zasób Message. Następnie Google Chat utworzy zdarzenie zawierające dane dotyczące nowego

Google Chat dzieli wydarzenia na kategorie według typu. Typy zdarzeń pomagają filtrować otrzymujesz tylko te rodzaje informacji, których potrzebujesz, i możesz zarządzać podobnymi działań w ten sam sposób.

W tabeli poniżej pokazujemy, jak aktywność w Google Chat wpływa na powiązany zasób interfejsu Chat API oraz typ zdarzenia Aplikacja do obsługi czatu otrzymuje:

Aktywność Zasób interfejsu Chat API Typ zdarzenia
Użytkownik publikuje wiadomość w pokoju czatu Zostanie utworzony zasób Message. Nowa wiadomość
Użytkownik staje się menedżerem pokoju. Zasób Membership został zaktualizowany. Subskrypcja została zaktualizowana
Użytkownik zareaguje na wiadomość. Zostanie utworzony zasób Reaction. Nowa reakcja
Użytkownik opuszcza pokój. Zasób Membership został usunięty. Usunięto subskrypcję

Odbieranie zdarzeń z Google Chat

Aby odbierać wydarzenia, aplikacja Google Chat może wykonywać jedną z tych czynności: :

  • Subskrybowanie zdarzeń za pomocą interfejsu Google Workspace Events API, aby otrzymywać zdarzenia w miarę ich występowania.
  • Wyślij zapytanie dotyczące ostatnich zdarzeń, wywołując interfejs Chat API.

W tabeli poniżej znajdziesz informacje o różnicach i przyczynach zapytań lub subskrybowanie wydarzeń:

Subskrybuj wydarzenia Zapytanie o zdarzenia
Przypadki użycia
  • Przetwarzaj zdarzenia i reaguj na nie w czasie rzeczywistym.
  • Monitorowanie użytkowników aktywności użytkowników i odkrywaj nowe pokoje, w których monitorowania.
  • Przetwarzaj zdarzenia lub reaguj na nie okresowo lub za pomocą reguł.
  • Pobierz pominięte wydarzenia z subskrypcji (z powodu przerwy w działaniu usługi lub nieaktywna subskrypcja).
Interfejs API Interfejs Google Workspace Events API Chat API
Źródło zdarzeń Pokoje i użytkownicy Tylko pokoje
Obsługiwane zdarzenia
  • Wiadomości
  • Wspieranie kanału
  • Reakcje
  • Spacja
.
Listę obsługiwanych typów zdarzeń znajdziesz w sekcji Typy zdarzeń związane z tworzeniem subskrypcji w sekcji Dokumentacja interfejsu Google Workspace Events API.
  • Wiadomości
  • Wspieranie kanału
  • Reakcje
  • Spacja
.
Listę obsługiwanych typów zdarzeń znajdziesz w spaceEvents zasób w Chat API dokumentacji referencyjnej.
Format zdarzenia Wiadomość Google Cloud Pub/Sub sformatowana zgodnie z Specyfikacja CloudEvent. Więcej informacji: Struktura zdarzeń Google Workspace. Zasób interfejsu Chat API ( spaces.spaceEvent)
Dane zdarzenia Ciąg zakodowany w standardzie Base64 z danymi zasobów lub bez nich. Przykładowe ładunki znajdziesz w artykule Dane zdarzeń. Ładunek JSON zawierający dane zasobów. Niektóre typy zdarzeń zawierają tylko określone pola zasobów. Na przykład ładunki znajdziesz w sekcji dokumentacji.

Przykład: wysyłanie zapytań o wydarzenia dotyczące członkostwa w pokoju lub subskrybowanie wydarzeń

W tym przykładzie aplikacja Google Chat chce otrzymywać informacje o zmianach dotyczących użytkowników pokoju czatu. W w pokoju zachodzą te działania związane z członkostwem:

  • Użytkownik dołącza do pokoju, co powoduje utworzenie zasobu Membership i aktywowanie wydarzenie nowego członka.
  • Użytkownik staje się menedżerem pokoju i aktualizuje zasób Membership w: użytkownika i wywoła zaktualizowane zdarzenie członka.
  • Użytkownik opuszcza pokój, co powoduje usunięcie zasobu Membership dla użytkownika i wywoła zdarzenie usunięcia członka.

Subskrybowanie wydarzeń członkowskich

Aby odbierać zdarzenia w czasie rzeczywistym, Aplikacja do obsługi czatu wywołuje interfejs Google Workspace Events API subscriptions.create() , aby zasubskrybować pokój na potrzeby wszystkich typów zdarzeń związanych z członkostwem. Po podczas tworzenia subskrypcji, aplikacja Google Chat może zacząć otrzymywania zdarzeń dotyczących członkostwa.

aplikacji do obsługi czatu, która subskrybuje wydarzenia za pomocą Interfejs Google Workspace Events API.
Rysunek 2. aplikacja Google Chat, odbiera zdarzenia członkostwa w ramach subskrypcji przy użyciu za pomocą interfejsu Google Workspace Events API.

Na ilustracji 2 aplikacja Google Chat ma aktywną subskrypcję w pokoju, więc aplikacja odbierze zdarzenie za każdym razem, gdy użytkownik dołączy do pokoju. zmian. Aplikacja Google Chat będzie mogła wtedy przetworzyć dane lub odpowiedzieć w czasie rzeczywistym do dowolnych działań, na przykład opublikować prywatną wiadomość powitalną użytkownik, który dołączył do pokoju.

Aby dowiedzieć się więcej o tworzeniu subskrypcji za pomocą interfejsu Google Workspace Events API, zapoznaj się z dokumentacją interfejsu Google Workspace Events API.

Zapytanie o ostatnie zdarzenia związane z członkostwem

Zamiast otrzymywać zdarzenia członkostwa w miarę ich występowania, Aplikacja do obsługi czatu może wywoływać interfejs Chat API, aby wyświetlić listę niedawnych wydarzeń kosmicznych związanych z aktywnością członków.

aplikacja do obsługi czatu, która wysyła zapytania o zdarzenia za pomocą funkcji Interfejs Chat API.
Rysunek 3. O Aplikacja do obsługi czatu odbiera ostatnie zdarzenia związane z członkostwem przez oraz wysyłać zapytania o wydarzenia w pokoju za pomocą interfejsu Chat API.

Na ilustracji 3 aplikacja do obsługi czatu wywołuje interfejs Chat API spaces.spaceEvents.list() po wystąpieniu wszystkich aktywności członkostwa i filtruje zapytanie. dla nowych, zaktualizowanych i usuniętych wydarzeń członkostwa. Interfejs Chat API zwraca listę spaceEvent zasobów, które reprezentują każdą zmianę subskrypcji. Aplikacja Google Chat może przetwarzać dane lub odpowiadać na nie na podstawie ostatnią aktywność, na przykład publikowanie cotygodniowej wiadomości z podsumowaniem aktywność użytkowników pokoju w ciągu ostatnich 7 dni.

Aby wysyłać zapytania o zdarzenia za pomocą interfejsu Chat API, zapoznaj się z artykułem Wyświetlanie listy zdarzeń z pokoju Google Chat

Ograniczenia
  • w przypadku subskrypcji użytkowników, wydarzeń dotyczących nowych członków na czacie lub w czatach grupowych bez nazwy (google.workspace.chat.membership.v1.created), uruchamia się dopiero po opublikowaniu pierwszej wiadomości.
  • Aby otrzymywać wydarzenia dla członków, użytkownik musi być bezpośrednim członkiem pokoju. Jeśli dodano użytkownika, które zostały zaktualizowane lub usunięte pośrednio do pokoju za pomocą grupy dyskusyjnej Google, subskrypcja nie te zdarzenia członkostwa. Aby dowiedzieć się, jak działa członkostwo w grupach dyskusyjnych Google, zapoznaj się z artykułem Dodawanie grupy dyskusyjnej Google do pokoju