Tworzenie interfejsów Google Chat

Na tej stronie znajdziesz omówienie tworzenia interfejsów dla dodatków Google Workspace, które rozszerzają Google Chat.

W Google Chat dodatki są widoczne dla użytkowników jako aplikacje Google Chat. Więcej informacji znajdziesz w artykule Omówienie rozszerzania Google Chat.

Aby tworzyć interfejsy aplikacji Google Chat, możesz używać tych komponentów dodatkowych:

  • Reguły: sposoby, w jakie użytkownicy Google Chat mogą wywoływać aplikację Google Chat, na przykład 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 użytkownika.
  • Czynności: sposoby, w jakie aplikacje do czatu mogą reagować na interakcje, takie jak wysyłanie wiadomości lub zwracanie interfejsu użytkownika opartego na kartach.
Aplikacja do obsługi czatu otrzymuje obiekt zdarzenia z wyzwalacza „dodano do pokoju”.
Ilustracja 1. Gdy użytkownik doda aplikację Google Chat do pokoju, zostanie uruchomiony reguła Dodano do pokoju, która wyśle obiekt zdarzenia. Aby odpowiedzieć wiadomością, aplikacja Google Chat przetwarza obiekt zdarzenia i zwraca działanie, które tworzy wiadomość.

Aplikacje czatu mogą tworzyć i wyświetlać karty w tych interfejsach:

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

Reguły

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

Wyzwalacze to konkretne sposoby, w jaki użytkownicy uruchamiają aplikację Google Chat za pomocą interfejsu Google Chat, np. za pomocą @wzmianek lub poleceń aplikacji.

W tabeli poniżej znajdziesz informacje o wyzwalaczach Google Chat, ich opisy oraz sposób, w jaki aplikacje Google Chat zwykle na nie reagują:

Wyzwalacz Opis Typowa odpowiedź
Dodano do pokoju

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

 Aplikacja Google Chat wysyła wiadomość powitalną, która wyjaśnia, do czego służy i jak użytkownicy w pokoju mogą z niej korzystać.
Wiadomość

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

  • Wysyła wiadomość w pokoju czatu z wiadomościami na czacie.
  • @wzmianka o aplikacji Chat w dowolnym pokoju.
  • Wysyła wiadomość zawierającą link pasujący do wzorca adresu URL podglądu linków.
  • Wpisuje tekst w menu wybierania wielu elementów w widżecie selectionInput.
 Aplikacja Google Chat odpowiada na podstawie treści wiadomości. Na przykład aplikacja Google Chat odpowiada na polecenie po ukośniku /about wiadomością z opisem zadań, które może wykonać.
Usunięto z pokoju

Użytkownik usuwa aplikację Google Chat z pokoju lub administrator Google Workspace odinstalowuje tę aplikację dla użytkownika w organizacji.

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

 Aplikacja Google Chat usuwa wszystkie przychodzące powiadomienia skonfigurowane dla pokoju (np. usuwanie webhooka) i czyści pamięć wewnętrzną. Aplikacje do czatu nie mogą odpowiadać na ten czynnik wiadomościami, ponieważ nie są już członkami pokoju.
Polecenie aplikacji

Użytkownik używa polecenia aplikacji Google Chat.

 Aplikacja Google Chat reaguje na polecenie. na przykład odpowiedzieć wiadomością lub otworzyć okno dialogowe.

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

Aby odpowiedzieć na zdarzenie, zapoznaj się z tymi przewodnikami:

Obiekty zdarzeń

Aplikacje do obsługi czatu otrzymują obiekty zdarzeń, gdy zostanie wywołany przez nie jakiś wyzwalacz lub gdy użytkownicy czatu wejdą w interakcję z interfejsem aplikacji (np. klikną przycisk). Obiekt zdarzenia zawiera dane o interakcji, których aplikacja Google Chat może używać do odpowiadania lub aktualizowania interfejsu.

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

Więcej informacji o obiektach zdarzeń dodatku w 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ć czynności dodatków do reagowania na interakcje użytkowników.

Aby odpowiedzieć za pomocą działania dodatku, aplikacja Google Chat 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 Google Chat musi skonfigurować uwierzytelnianie i wywołać interfejs Google Chat API, aby odpowiedzieć.

Aplikacje do czatu mogą obsługiwać interakcje i reagować na nie na wiele sposobów. W wielu przypadkach aplikacje do czatu odpowiadają wiadomością. Aplikacje do czatu mogą też wyszukiwać informacje w źródłach danych, rejestrować informacje o obiekcie zdarzenia lub cokolwiek innego. To zachowanie definiuje aplikację Google Chat.

Aby odpowiadać na interakcje użytkownika, 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 przypadku zwrotu
Wyślij lub zaktualizuj wiadomość. DataActions
Otwórz, zaktualizuj lub zamknij okno. RenderActions
Aby zbierać informacje z karty lub okna dialogowego, 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 czatu w pokoju. DataActions

Odpowiadanie za pomocą interfejsu Google Chat API

Zamiast zwracać działanie dodatku aplikacje do obsługi czatu mogą potrzebować interfejsu Google Chat API do odpowiadania na interakcje. Na przykład aplikacje czatu muszą wywoływać interfejs Google Chat API, aby:

  • Odpowiedz na interakcję w ciągu 30 sekund.
  • wykonywać czynności poza pokojem, w którym doszło do interakcji;
  • wykonywanie w Google Chat zadań, które nie są dostępne jako dodatki; Możesz na przykład wyświetlić listę pokoi, których użytkownik lub aplikacja Google Chat jest członkiem, lub dodać użytkowników do pokoju.
  • Wykonywanie zadań w imieniu użytkownika czatu (wymaga uwierzytelnienia użytkownika).

Więcej informacji o uwierzytelnianiu i wywoływaniu interfejsu Chat API znajdziesz w artykule Przegląd interfejsu Chat API.