Tworzenie interfejsów Google Chat

Na tej stronie znajdziesz omówienie tworzenia interfejsów użytkownika (UI) dla dodatków do Google Workspace, które rozszerzają Google Chat.

Do tworzenia interfejsów aplikacji Google Chat używasz tych komponentów dodatku:

  • Wywołania: sposoby, w jakie użytkownicy Google Chat mogą wywoływać aplikację Google Chat, np. dodając ją do pokoju lub wysyłając do niej wiadomość.
  • Obiekty zdarzeń: dane, które aplikacje Google Chat otrzymują z wyzwalaczy lub interakcji z interfejsem.
  • Czynności: sposoby, w jakie aplikacje do obsługi czatu mogą reagować na interakcje, np. wysyłać wiadomości lub zwracać interfejs użytkownika oparty na kartach.
Aplikacja do obsługi czatu otrzymuje obiekt zdarzenia z wyzwalacza Dodano do pokoju
Ilustracja 1. Gdy użytkownik dodaje aplikację Google Chat do pokoju, wywoływana jest reguła Dodano do pokoju, która wysyła obiekt zdarzenia. Aby odpowiedzieć wiadomością, aplikacja Chat obsługuje obiekt zdarzenia i zwraca działanie, które tworzy wiadomość.

Aplikacje do obsługi czatu mogą tworzyć i wyświetlać karty w tych interfejsach:

  • Wiadomości, które mogą zawierać tekst, statyczne lub interaktywne karty oraz przyciski.
  • Okna, czyli karty, które otwierają się w nowym oknie i zwykle proszą użytkowników o przesłanie informacji.
  • Podglądy linków, czyli karty, które zawierają podgląd informacji o usłudze zewnętrznej.

Reguły

W tej sekcji opisujemy wyzwalacze, których dodatki do Google Workspace używają w Google Chat.

Aktywatory to konkretne sposoby, w jakie użytkownicy wywołują aplikację do obsługi czatu za pomocą interfejsu Google Chat, np. używając wzmianek lub poleceń aplikacji.

W tabeli poniżej znajdziesz wyzwalacze Google Chat, ich opis i sposób, w jaki aplikacje Google Chat zwykle na nie reagują:

Wyzwalacz Opis Typowa odpowiedź
Dodano do pokoju

Użytkownik dodaje aplikację do obsługi czatu do pokoju lub administrator Google Workspace instaluje aplikację do obsługi czatu w pokojach czatu dla użytkowników w organizacji. Więcej informacji o aplikacjach do obsługi czatu zainstalowanych przez administratorów znajdziesz w artykule Instalowanie aplikacji z Marketplace w domenie w dokumentacji pomocy Google Workspace dla administratorów.

 Aplikacja Chat wysyła wiadomość wprowadzającą, która wyjaśnia, do czego służy i jak użytkownicy w pokoju mogą z nią wchodzić w interakcję.
Wiadomość

Użytkownik wchodzi w interakcję z aplikacją Chat w wiadomości na jeden z tych sposobów:

  • Wysyła wiadomość w pokoju z wiadomościami na czacie za pomocą aplikacji Chat.
  • wzmianki o aplikacji do obsługi czatu w dowolnym typie pokoju;
  • Wysyła wiadomość zawierającą link pasujący do wzorca adresu URL podglądów linków.
  • Wpisuje tekst w menu wielokrotnego wyboru widżetu selectionInput.
 Aplikacja Chat odpowiada na podstawie treści wiadomości. Na przykład aplikacja do obsługi czatu odpowiada na polecenie po ukośniku /about wiadomością, która wyjaśnia zadania, jakie może wykonać.
Usunięto z pokoju

użytkownik usunie aplikację do obsługi czatu z pokoju lub administrator Google Workspace odinstaluje aplikację do obsługi czatu dla użytkownika w organizacji.

Użytkownicy nie mogą usuwać aplikacji Google Chat zainstalowanych przez administratora. Jeśli użytkownik zainstalował wcześniej aplikację Chat, pozostanie ona zainstalowana niezależnie od tego, czy administrator Google Workspace spróbuje ją odinstalować.

 Aplikacja Chat usuwa wszystkie powiadomienia przychodzące skonfigurowane dla pokoju (np. usuwa webhook) i czyści pamięć wewnętrzną. Aplikacje do obsługi czatu nie mogą odpowiadać na ten wyzwalacz, ponieważ nie należą już do pokoju.
Polecenie aplikacji

Użytkownik używa polecenia aplikacji Google Chat.

 Aplikacja Chat odpowie na polecenie. Na przykład odpowiada na wiadomość lub otwiera okno dialogowe.

W przeciwieństwie do innych dodatków do Google Workspace funkcje wywołania zwrotnego dla tych wyzwalaczy musisz skonfigurować za pomocą Google Chat API. Więcej informacji znajdziesz w artykule Konfigurowanie aplikacji Google Chat.

Aby odpowiedzieć na wywołanie, zapoznaj się z tymi przewodnikami:

Obiekty zdarzeń

Aplikacje do obsługi czatu otrzymują obiekty zdarzeń, gdy uruchamia się wyzwalacz Google Chat lub gdy użytkownicy Google Chat wchodzą w interakcję z interfejsem aplikacji do obsługi czatu (np. klikają przycisk). Obiekt zdarzenia zawiera dane o interakcji, których aplikacja do obsługi czatu może użyć do odpowiedzi lub zaktualizowania interfejsu.

Więcej informacji o obsłudze obiektów zdarzeń znajdziesz w tych przewodnikach:

Więcej informacji o obiektach zdarzeń dodatków w Google Chat i innych aplikacjach Google Workspace znajdziesz w artykule Obiekty zdarzeń.

Działania na czacie

W tej sekcji wyjaśniamy, jak aplikacje Google Chat mogą używać działań dodatku, aby odpowiadać na interakcje użytkowników.

Aby odpowiedzieć za pomocą działania dodatku, aplikacja do obsługi czatu musi odpowiedzieć w ciągu 30 sekund, a odpowiedź musi zostać opublikowana w pokoju, w którym nastąpiła interakcja. W przeciwnym razie aplikacja do obsługi czatu musi skonfigurować uwierzytelnianie i wywołać interfejs Google Chat API, aby odpowiedzieć.

Aplikacje do czatu mogą obsługiwać interakcje i na nie odpowiadać na wiele sposobów. W wielu przypadkach aplikacje Chat odpowiadają wiadomością. Aplikacje do obsługi czatu mogą też wyszukiwać informacje w źródle danych, rejestrować informacje o obiekcie zdarzenia lub wykonywać inne czynności. Ten sposób przetwarzania danych jest podstawą działania aplikacji Google Chat.

Aby odpowiadać na interakcje użytkowników, aplikacje do obsługi czatu muszą obsługiwać odpowiedni obiekt zdarzenia i zwracać jeden z tych obiektów JSON:

Odpowiedź aplikacji do obsługi czatu Wymagane działanie w celu zwrotu
Wysyłanie lub aktualizowanie wiadomości DataActions
Otwieranie, aktualizowanie i zamykanie okien. RenderActions
Aby zbierać informacje z karty lub okna, sugeruj elementy wyboru na podstawie tego, co użytkownicy wpisują w menu wielokrotnego wyboru. RenderActions
podgląd linków w wiadomościach wysyłanych przez użytkowników Google Chat w pokoju. DataActions

Odpowiadanie za pomocą interfejsu Google Chat API

Zamiast zwracać działanie dodatku, aplikacje do obsługi czatu mogą używać interfejsu Google Chat API, aby odpowiadać na interakcje. Na przykład aplikacje do obsługi czatu muszą wywoływać interfejs Google Chat API, aby wykonać dowolne z tych działań:

  • Odpowiadaj na interakcje po 30 sekundach.
  • wykonywać zadań poza pokojem, w którym doszło do interakcji,
  • wykonywać w Chat zadań, które nie są dostępne jako działania dodatku; Możesz na przykład wyświetlić listę pokoi, w których użytkownik lub aplikacja Google Chat jest członkiem, lub dodać użytkowników do pokoju.
  • wykonywać zadania w imieniu użytkownika Chatu (co wymaga uwierzytelnienia użytkownika);

Więcej informacji o uwierzytelnianiu i wywoływaniu interfejsu Chat API znajdziesz w omówieniu interfejsu Chat API.