Tworzenie aplikacji Google Chat za pomocą Google Apps Script

Podgląd dla deweloperów: dostępny w ramach Programu Google Workspace dla deweloperów, który zapewnia wcześniejszy dostęp do niektórych funkcji.

Na tej stronie znajdziesz instrukcje tworzenia dodatku do Google Workspace, który działa w Google Chat za pomocą Google Apps Script. 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.

Aplikacja Google Chat umożliwia wysyłanie wiadomości bezpośrednio do rozmówców i odpowiedzi na nie w postaci powtórzenia.

Ten diagram przedstawia architekturę i schemat przesyłania komunikatów:

Na powyższym diagramie użytkownik korzystający z aplikacji Google Chat opartej na Apps Script ma dostęp do tych informacji:

1. Użytkownik wysyła wiadomość do aplikacji Google Chat w formie wiadomości bezpośredniej lub w pokoju czatu.
2. Logika aplikacji Google Chat zaimplementowana w Google Apps Script, która znajduje się w Google Cloud, odbiera i przetwarza wiadomość.
3. Opcjonalnie logika aplikacji Google Chat może zostać zintegrowana z usługami Google Workspace, takimi jak Kalendarz czy Arkusze, lub innymi usługami Google, takimi jak Mapy Google czy YouTube.
4. Logika aplikacji Google Chat wysyła odpowiedź z powrotem do usługi aplikacji Google Chat w Google Chat.
5. Odpowiedź jest dostarczana użytkownikowi.

Cele

• skonfigurować środowisko,
• Skonfiguruj skrypt.
• Skonfiguruj dodatek Google Workspace dla aplikacji Google Chat.
• przetestuj aplikację Google Chat;

Wymagania wstępne

• Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
• projekt Google Cloud, Aby go utworzyć, zapoznaj się z artykułem Tworzenie projektu Google Cloud.

Konfigurowanie środowiska

Otwieranie projektu Cloud w konsoli Google Cloud

Jeśli nie jest jeszcze otwarty, otwórz projekt Cloud, którego chcesz użyć w przykładzie:

1. W konsoli Google Cloud otwórz stronę Wybierz projekt.

   Wybierz projekt Cloud

2. Wybierz projekt Google Cloud, którego chcesz użyć. Możesz też kliknąć Utwórz projekt i postępować zgodnie z instrukcjami wyświetlanymi na ekranie. Jeśli utworzysz projekt Google Cloud, konieczne może być włączenie płatności.

Włączanie interfejsu Chat API

Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.

• W konsoli Google Cloud włącz interfejs Google Chat API.

  Włączanie interfejsu API

Konfigurowanie ekranu zgody OAuth

Wszystkie aplikacje korzystające z protokołu OAuth 2.0 wymagają skonfigurowania ekranu zgody. Konfigurując ekran zgody OAuth aplikacji, określasz, co ma się wyświetlać użytkownikom i sprawdzającym aplikację, a także rejestrujesz aplikację, aby móc ją później opublikować.

1. W konsoli Google Cloud otwórz Menu  > > Identyfikacja marki.

   Otwórz Branding

2. Jeśli masz już skonfigurowany projekt , możesz skonfigurować te ustawienia ekranu zgody OAuth: Markowanie, Odbiorcy i Dostęp do danych. Jeśli zobaczysz komunikat nie skonfigurowano, kliknij Rozpocznij:
1. W sekcji Informacje o aplikacji w polu Nazwa aplikacji wpisz nazwę aplikacji.
2. W sekcji Adres e-mail dla użytkowników potrzebujących pomocy wybierz adres e-mail zespołu pomocy, pod którym użytkownicy będą mogli się z Tobą skontaktować w sprawie pytań dotyczących zgody.
3. Kliknij Dalej.
4. W sekcji Odbiorcy wybierz Wewnętrzny.
5. Kliknij Dalej.
6. W sekcji Dane kontaktowe wpisz adres e-mail, na który będą wysyłane powiadomienia o zmianach w projekcie.
7. Kliknij Dalej.
8. W sekcji Zakończ zapoznaj się z zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google, a potem, jeśli się z nimi zgadzasz, kliknij Akceptuję zasady dotyczące danych użytkownika w usługach interfejsu API Google.
9. Kliknij Dalej.
10. Kliknij Utwórz.
3. Na razie możesz pominąć dodawanie zakresów. Gdy w przyszłości będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny. Następnie dodaj zakresy autoryzacji wymagane przez Twoją aplikację. Więcej informacji znajdziesz w pełnym przewodniku Konfigurowanie zgody OAuth.

Konfigurowanie skryptu

Aby skonfigurować skrypt, użyj szablonu aplikacji Google Chat na stronie Rozpoczynanie w Apps Script, a następnie połącz skrypt z projektem Cloud.

Tworzenie projektu Apps Script

1. Na stronie Apps Script Rozpoczęcie kliknij Wprowadzenie do dodatków i wybierz szablon Aplikacja do czatu:

   Otwórz szablon w aplikacji Google Chat

2. W nowym projekcie Apps Script, który się otworzy, nadaj mu nazwę:

   1. Kliknij Projekt bez nazwy.

   2. W polu Nazwa projektu wpisz Add-on Chat app.

   3. Kliknij Zmień nazwę.

Skopiuj numer projektu Cloud

1. W konsoli Google Cloud kliknij Menu  > Administracja > Ustawienia.

   Otwórz Ustawienia w obszarze Administracja

2. W polu Numer projektu skopiuj wartość.

Ustawianie projektu Cloud w projekcie Apps Script

1. W projekcie Apps Script aplikacji Google Chat kliknij Ustawienia projektu .
2. W sekcji Projekt Google Cloud Platform (GCP) kliknij Zmień projekt.
3. W polu Numer projektu GCP wklej numer projektu Google Cloud.
4. Kliknij Ustaw projekt.

Masz już działający kod aplikacji, który możesz wypróbować (zgodnie z opisem w następujących krokach), a potem dostosować do swoich potrzeb.

Pamiętaj, aby przed otwarciem projektu Apps Script zalogować się na odpowiednie konto Google. Czasami bieżące konto może przełączyć się na domyślne bez Twojej wiedzy.

Tworzenie testowego wdrożenia

Potrzebujesz identyfikatora wdrożenia tego projektu Apps Script, aby użyć go w następnym kroku.

Aby uzyskać identyfikator głównego wdrożenia:

1. W projekcie Apps Script aplikacji Google Chat kliknij Wdróż > Testuj wdrożenia.
2. Skopiuj identyfikator wdrożenia głównego, aby użyć go w następnym kroku, i kliknij Gotowe.

Konfigurowanie dodatku

Aby utworzyć dodatek i wdrożyć aplikację Google Chat, wykonaj te czynności w ramach wdrożenia Apps Script:

1. W konsoli wyszukaj Google Chat API i kliknij Google Chat API.
2. Kliknij Zarządzaj.

3. Kliknij Konfiguracja i skonfiguruj aplikację Google Chat:

   1. W polu Nazwa aplikacji wpisz Add-on Chat app.
   2. W polu Adres URL awatara wpisz https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png.
   3. W polu Opis wpisz Add-on Chat app.
   4. W sekcji Funkcje wybierz Odbieranie wiadomości 1:1 i Dołączanie do pokoi i rozmów grupowych.
   5. W sekcji Ustawienia połączenia kliknij Projekt Apps Script.
   6. W polu Deployment ID (Identyfikator wdrożenia) wklej skopiowany wcześniej identyfikator wdrożenia głównego.
   7. W sekcji Widoczność wybierz Określone osoby i grupy w Twojej domenie, a następnie wpisz swój adres e-mail.

4. Kliknij Zapisz.

Aplikacja Google Chat jest gotowa do odpowiadania na wiadomości.

Testowanie aplikacji Google Chat

Aby przetestować aplikację Google Chat, otwórz czat z aplikacją i wyślij wiadomość:

1. Otwórz Google Chat za pomocą konta Google Workspace, które zostało podane podczas dodawania siebie jako zaufanego testera.

   Otwórz Google Chat

2. Kliknij Nowy czat.
3. W polu Dodaj co najmniej 1 osobę wpisz nazwę aplikacji Google Chat.

4. Wybierz aplikację Google Chat z wyników. Otworzy się czat.

   Uwaga: jeśli nie widzisz aplikacji Google Chat na liście wyników, sprawdź, czy Twoje konto Google Workspace jest uwzględnione w ustawieniach widoczności na stronie Konfiguracja interfejsu Chat API w konsoli Google Cloud.

5. Na nowym czacie z aplikacją wpisz Hello i kliknij enter.

   Aplikacja Google Chat dziękuje za dodanie i powtarza Twoją wiadomość.

Aby dodać zaufanych testerów i dowiedzieć się więcej o testowaniu funkcji interaktywnych, przeczytaj artykuł Testowanie funkcji interaktywnych w aplikacjach Google Chat.

Rozwiązywanie problemów

Gdy aplikacja Google Chat lub karta zwróci błąd, interfejs Google Chat wyświetli komunikat „Coś poszło nie tak”. lub „Nie udało się przetworzyć Twojej prośby”. Czasami interfejs czatu nie wyświetla żadnego komunikatu o błędzie, ale aplikacja lub karta czatu powoduje nieoczekiwany wynik, na przykład może nie wyświetlać się wiadomość na karcie.

Komunikat o błędzie może się nie wyświetlać w interfejsie czatu, ale gdy włączone jest rejestrowanie błędów w przypadku aplikacji czatu, dostępne są opisowe komunikaty o błędach i dane dziennika, które ułatwiają ich rozwiązywanie. Informacje o wyświetlaniu, debugowaniu i poprawianiu błędów znajdziesz w artykule Rozwiązywanie problemów z błędami Google Chat.

Czyszczenie danych

Aby uniknąć obciążenia konta Google Cloud opłatami za zasoby zużyte w tym samouczku, zalecamy usunięcie projektu Google Cloud.

Uwaga: usunięcie projektu spowoduje, że:

• Wszystkie dane projektu zostaną usunięte. Jeśli do tego samouczka został użyty istniejący projekt, jego usunięcie spowoduje również usunięcie wszystkich innych zadań w nim wykonanych.
• Niestandardowe identyfikatory projektu zostaną utracone. Podczas tworzenia tego projektu możesz utworzyć niestandardowy identyfikator projektu, którego chcesz użyć w przyszłości. Aby zachować adresy URL, które używają identyfikatora projektu, np. adres URL na appspot.com, usuń wybrane zasoby w projekcie zamiast usuwać cały projekt.

Jeśli zamierzasz skorzystać z innych samouczków i krótkich wprowadzeń, ponowne wykorzystanie tych samych projektów może pomóc Ci uniknąć przekroczenia Iimitów związanych z projektami.

1. W konsoli Google Cloud otwórz stronę Zarządzanie zasobami. Kliknij Menu > Administracja > Zarządzaj zasobami.

   Otwórz Menedżera zasobów

2. Na liście projektów wybierz projekt, który chcesz usunąć, a potem kliknij Usuń .
3. W oknie wpisz identyfikator projektu i kliknij Wyłącz, aby usunąć projekt.