Na tej stronie znajdziesz instrukcje konfigurowania i wdrażania aplikacji Google Chat jako dodatku do Google Workspace.
Aby wdrożyć i przetestować dodatek Google Workspace, który rozszerza Google Chat, musisz włączyć i skonfigurować aplikację Google Chat za pomocą interfejsu Google Chat API. W ustawieniach konfiguracji interfejsu Chat API możesz określić wszystkie szczegóły dotyczące aplikacji do obsługi czatu, w tym nazwę, awatar, wdrożenie i funkcje interaktywne, których chcesz używać.
Wymagania wstępne
HTTP
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz te interfejsy Google Workspace API:
- Interfejs API aplikacji Google Chat
- Interfejs API Google Workspace Add-ons
- Punkt końcowy HTTP, który hostuje architekturę usługi w aplikacji Chat.
Google Apps Script
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz Google Chat API.
- Utwórz samodzielny projekt Apps Script i włącz zaawansowaną usługę Google Chat.
- Skonfiguruj czat w pliku manifestu, dodając obiekt
addons.chat
i wymagane zakresy (oauthScopes
) lub prefiksy adresów URL HTTPS (urlFetchWhitelist
).
Wybieranie nazwy, awatara i opisu aplikacji Google Chat
Nazwa, awatar i opis aplikacji Google Chat są wyświetlane użytkownikom w interfejsie Google Chat. Aby korzystać z aplikacji do czatu, użytkownicy widzą lub używają tych informacji w następujący sposób:
- @wzmianka o aplikacji Czat, aby dodać ją do pokoju lub wysłać do niej wiadomość.
- Znajdź i rozpocznij czat w aplikacji Google Chat. W menu Aplikacje czaty wyświetlają nazwę i awatar aplikacji Google Chat.
- Na pasku tworzenia użytkownicy mogą przeglądać aplikacje Google Chat oraz wyświetlać swoje imię i nazwisko, awatar i opis.
Zanim skonfigurujesz aplikację do czatu, musisz przygotować te informacje:
Pole | Opis | Format |
---|---|---|
Nazwa aplikacji | Wyświetlana nazwa aplikacji Google Chat. | Maks. 25 znaków alfanumerycznych |
URL awatara | Obraz, który wyświetla się jako awatar w aplikacji Google Chat. | Adres URL HTTPS wskazujący na kwadratowy obraz graficzny (PNG lub JPEG). Zalecany rozmiar to co najmniej 256 × 256 pikseli. |
Opis | Krótki opis celu aplikacji Google Chat. | Maks. 40 znaków alfanumerycznych |
W sekcji poniżej podajesz te informacje w ustawieniach konfiguracji interfejsu Chat API.
Konfigurowanie aplikacji Google Chat w konsoli Google Cloud
Gdy masz już informacje o aplikacji Google Chat, otwórz projekt Cloud i skonfiguruj interfejs Chat API:
W konsoli Google Cloud otwórz stronę interfejsu API czatu i kliknij Konfiguracja:
W sekcji Informacje o aplikacji wypełnij pola Nazwa aplikacji, URL awatara i Opis.
W sekcji Funkcje interaktywne ustaw suwak Włącz funkcje interaktywne w pozycji włączonej i wykonaj te czynności:
W sekcji Funkcjonalność zaznacz co najmniej 1 pole wyboru, aby umożliwić instalowanie i używanie aplikacji Google Chat:
Odbieranie wiadomości 1:1: użytkownicy mogą zainstalować aplikację Google Chat i wysyłać do niej wiadomości w dedykowanym pokoju.
Dołączanie do pokoi i rozmów grupowych: użytkownicy mogą dodawać aplikację Google Chat do pokoi z wieloma osobami i z nią współpracować.
W sekcji Ustawienia połączenia wybierz architekturę, której chcesz używać do odbierania obiektów zdarzeń z czatu:
- Aby korzystać z usługi HTTP, wybierz URL punktu końcowego HTTP i wpisz adres URL.
- Aby użyć projektu Google Apps Script, wybierz Apps Script i podaj identyfikator wdrożenia tego projektu.
Opcjonalnie: aby otrzymywać obiekty zdarzeń w większej liczbie punktów końcowych lub funkcji, otwórz Ustawienia zaawansowane > Reguły i podaj lub zaktualizuj funkcje wywołania zwrotnego w przypadku tych reguł czatu:
- ADDED_TO_SPACE użytkownik dodaje aplikację Google Chat do rozmowy grupowej lub pokoju albo instaluje ją, aby wysyłać wiadomości 1:1.
- MESSAGE użytkownik wysyła wiadomość do aplikacji Google Chat. Może to być na przykład wiadomość na czacie do aplikacji Google Chat lub @wzmianka o aplikacji Google Chat w pokoju z wieloma osobami.
- REMOVED_FROM_SPACE: użytkownik odinstalował lub usunął aplikację Google Chat z pokoju.
- APP_COMMAND: użytkownik używa szybkiego polecenia lub polecenia po ukośniku w aplikacji Google Chat.
Opcjonalnie: dodaj inne funkcje interaktywne, takie jak szybkie polecenia, slash commands lub podglądy linków.
W sekcji Widoczność podaj swój adres e-mail, aby zainstalować i przetestować aplikację Chat, zanim opublikujesz ją w Google Workspace Marketplace. Możesz wskazać maksymalnie 5 osób lub co najmniej 1 grupę Google z Twojej organizacji Google Workspace.
Opcjonalnie: w sekcji Logi zaznacz pole wyboru Logowanie błędów w Cloud Logging, aby używać Google Cloud Logging. Więcej informacji znajdziesz w dokumentacji interfejsu Chat API w sekcji Dzienniki błędów zapytań w aplikacjach Google Chat.
Kliknij Zapisz.
Po zapisaniu konfiguracji każda osoba, która została określona w ustawieniu Widoczność interfejsu API Google Chat, może zainstalować, przetestować lub użyć aplikacji Google Chat. Aby rozpocząć testowanie i debugowanie aplikacji Google Chat, zapoznaj się z sekcją Testowanie funkcji interaktywnych aplikacji Google Chat w dokumentacji interfejsu API Google Chat.
Informacje dotyczące dotychczasowych dodatków do Google Workspace
Aplikacje do obsługi czatu wymagają innej konfiguracji niż dodatki do Google Workspace, które rozszerzają inne aplikacje Google Workspace. Jeśli Twój dodatek rozszerza inne aplikacje Google Workspace, pamiętaj o tych wymaganiach dotyczących konfigurowania aplikacji Google Chat:
- Zarówno użytkownicy indywidualni, jak i administratorzy Google Workspace muszą mieć możliwość zainstalowania Twojego dodatku z Marketplace. Te ustawienia instalacji konfigurujesz w pakiecie SDK Google Workspace Marketplace.
- Aplikacje do obsługi czatu nie używają nazwy ani logo skonfigurowanych dla innych aplikacji Google Workspace w obiekcie
addons.common
w pliku manifest. - W przypadku dodatków opublikowanych w Google Workspace Marketplace nie można zapisać wersji roboczej zmian w ustawieniach interfejsu Google Chat API. Po zaktualizowaniu i zapisaniu ustawień konfiguracji interfejsu API Google Chat zaktualizowana aplikacja Google Chat będzie dostępna dla wszystkich dotychczasowych użytkowników. Aby zaktualizować informacje o produkcie w Marketplace, przed przesłaniem zmian możesz utworzyć wersję roboczą.
Jeśli dodatek został utworzony za pomocą Apps Script:
- Musisz użyć tego samego identyfikatora wdrożenia Apps Script, którego używasz w przypadku reszty konfiguracji dodatku.
- Nie możesz używać edytora Apps Script do instalowania testowych wdrożeń w Google Chat. Zamiast tego musisz instalować je bezpośrednio z poziomu interfejsu czatu.
Jeśli dodatek został utworzony przy użyciu usługi HTTP, pomiń wszelkie szczegóły konfiguracji aplikacji Chat w pliku manifestu i wdrożeniach utworzonych za pomocą interfejsu API dodatków Google Workspace. Wdrożenia HTTP określone w pakiecie SDK Google Workspace Marketplace są używane tylko w innych aplikacjach Google Workspace.
Powiązane artykuły
- Aby zarządzać dostępem do interfejsu Chat API, przeczytaj artykuł Konfigurowanie interfejsu Google Chat API w dokumentacji interfejsu Google Chat API.
- Testowanie funkcji interaktywnych w aplikacjach Google Chat
- Publikowanie aplikacji Google Chat