Tworzenie dodatków do Google Workspace

Dowiedz się, jak projektować, tworzyć i publikować dodatki do Google Workspace:

  1. Określ aplikacje Google Workspace, w których dodatek ma być dostępny dla użytkowników.
  2. Skonfiguruj projekty dodatku i wybierz właściciela oraz współpracowników.
  3. Zaprojektuj i skonfiguruj wygląd oraz działanie dodatku.
  4. Utwórz dodatek.
  5. Sprawdź zakresy OAuth dodatku.
  6. Przetestuj dodatek w co najmniej 1 aplikacji Google Workspace.
  7. Opublikuj dodatek.

Tworzenie dodatku za pomocą Apps Script lub HTTP. Aby porównać te 2 opcje, obejrzyj film „Apps Script vs. HTTP endpoints: Which should you choose?” (Apps Script a punkty końcowe HTTP: co wybrać?). 🤔”.

Wybieranie aplikacji hostowanych Google Workspace

Możesz skonfigurować dodatki Google Workspace tak, aby pojawiały się w tych aplikacjach hostowanych Google Workspace:

  • Gmail
  • Kalendarz Google
  • Google Chat
  • Dokumenty Google
  • Dysk Google
  • Google Meet
  • Arkusze Google
  • Prezentacje Google

Informacje o tworzeniu aplikacji dla Google Workspace znajdziesz w artykule Rozszerzanie interfejsu Google Workspace.

Konfigurowanie projektów dodatku oraz wybieranie właściciela i współpracowników

Jeśli tworzysz dodatek w Apps Script, tworzysz zarówno projekt Apps Script, jak i projekt Google Cloud. Jeśli tworzysz dodatek w języku innym niż Apps Script, musisz tylko utworzyć projekt Google Cloud.

Aby utworzyć dodatek, musisz skonfigurować zarówno projekt skryptu, jak i projekt w chmurze.

Zanim zaczniesz tworzyć dodatek, wybierz jedno konto użytkownika, które będzie właścicielem projektów, i zdecyduj, które inne konta będą współpracownikami. Właściciel projektu tworzy pliki projektu i powiązane ustawienia oraz nimi zarządza, a współpracownicy mogą pomagać w kodowaniu i testowaniu.

Projekty Apps Script

Zanim zaczniesz tworzyć dodatek, zapoznaj się z limitami i ograniczeniami Apps Script, aby dostosować projekt do tych wytycznych. Apps Script najlepiej sprawdza się w przypadku lekkiego tworzenia dodatków osobistych lub wewnętrznych z niewielką bazą użytkowników. Jeśli dodatek wymaga obsługi wielu użytkowników, niskiego czasu oczekiwania lub pełnej kontroli nad infrastrukturą, rozważ użycie innego środowiska wykonawczego.

Pliki projektu Apps Script dodatku twórz na dysku współdzielonym, aby żadne konto nie było jedynym właścicielem. Umieszczenie pliku skryptu dodatku na dysku współdzielonym zapewnia wszystkim współpracownikom dostęp do projektu skryptu.

Gdy opublikujesz dodatek, wydawcą będzie jedno konto użytkownika. Konto publikujące musi mieć uprawnienia do edycji projektu skryptu, ale nie musi być jego właścicielem.

Aby utworzyć projekt Apps Script, zapoznaj się z artykułem Projekty skryptów.

Projekty Google Cloud

Dodaj współpracowników do projektu w chmurze dodatku. Dzięki temu Twój zespół będzie mieć zawsze dostęp do ustawień dodatku w chmurze.

Aby utworzyć projekt Google Cloud, zapoznaj się z artykułem Tworzenie projektu Google Cloud.

Projektowanie i konfigurowanie wyglądu oraz działania dodatku

Zanim zaczniesz tworzyć dodatek, zdecyduj, jak ma wyglądać i działać. Zastanów się, w jakich przypadkach użycia ten dodatek może się przydać. Zacznij od podstawowego projektu, aby najpierw zacząć pracę, a potem wprowadź ulepszenia.

Wskazówki dotyczące projektowania interfejsu użytkownika dodatku znajdziesz w przewodniku po stylu dodatków do Google Workspace.

Konfigurowanie pliku manifestu dodatku

Zaimplementuj projekt w pliku manifestu dodatku. Skonfiguruj wygląd i działanie dodatku w pliku manifestu, w tym aplikacje hostowane Google Workspace, które rozszerza dodatek.

Więcej informacji znajdziesz w artykule Pliki manifestu dodatku do Google Workspace.

W miarę dodawania kodu i funkcji aktualizuj manifest, aby zdefiniować wymagany wygląd i działanie dodatku.

Konfigurowanie wyglądu i działania aplikacji Google Chat

Jeśli projektujesz dodatek, który rozszerza Google Chat, użyj interfejsu Google Chat API, aby skonfigurować wygląd i działanie aplikacji do obsługi czatu. Instrukcje znajdziesz w artykule Korzystanie z interfejsu Google Chat API.

Tworzenie dodatku

Zaimplementuj interfejs dodatku oparty na kartach. Użyj usługi kart lub, jeśli używasz innego języka kodu, zwróć sformatowany kod JSON, aby interfejs renderował karty.

Zaimplementuj wszystkie funkcje wyzwalające określone w pliku manifestu dodatku. Jeśli dodatek łączy się z usługą zewnętrzną za pomocą protokołu OAuth, skonfiguruj OAuth dla tej usługi.

Tworzenie kart

Zdefiniuj interfejs użytkownika dodatku, tworząc obiekty Card i dodając widżety. Funkcje wyzwalające określone w pliku manifestu muszą zwracać pojedynczy obiekt Card lub tablicę obiektów Card, które reprezentują różne „strony” interfejsu dodatku. Dodatek może też tworzyć i wyświetlać nowe karty w odpowiedzi na działania użytkownika.

W Apps Script utwórz karty za pomocą klasy CardBuilder. Każda karta wymaga CardHeader i co najmniej jednego CardSections. Wypełnij każdą sekcję karty poszczególnymi widżetami, które składają się na interfejs. Widżety interakcji są zwykle powiązane z działaniami, aby określić ich zachowanie podczas interakcji.

Po dodaniu wszystkich sekcji i widżetów do karty za pomocą jej CardBuilder wywołaj CardBuilder.build, aby utworzyć odpowiedni obiekt Card.

Używaj wbudowanych usług Apps Script, takich jak CalendarApp, aby pobierać informacje do wyświetlania na kartach dodatku. korzystać z danych z usług innych niż Google;

Jeśli dodatek potrzebuje dostępu do interfejsów API innych niż Google, które wymagają OAuth, skonfiguruj i połącz się z tą usługą – zapoznaj się z przewodnikiem dotyczącym łączenia się z usługami innymi niż Google.

Zamówienie budowlane

Podczas tworzenia karty zaczynaj od góry. Użyj tej kolejności konstrukcji:

  1. Utwórz widżet.
  2. Dodaj widżet do sekcji kart.
  3. Powtarzaj te czynności, aż sekcja kart będzie zawierać wszystkie widżety.
  4. Dodaj sekcję karty do karty.

Dzieje się tak, ponieważ gdy dodajesz widżet do karty lub sekcji karty, w rzeczywistości dodajesz jego kopię. Zmiany wprowadzone w obiekcie widżetu po jego dodaniu nie są odzwierciedlane na karcie końcowej.

Działania uniwersalne

Używaj działań uniwersalnych, aby udostępniać funkcje niezależne od kontekstu. Działania uniwersalne to elementy menu dostępne w interfejsie dodatku niezależnie od karty. Wszystkie zdefiniowane działania uniwersalne są widoczne w menu karty dodatku.

Więcej informacji znajdziesz w artykule Działania uniwersalne.

Sprawdzanie zakresów protokołu OAuth dodatku

Zakresy określają działania, które dodatek może wykonywać w imieniu użytkownika. Dodatki powinny mieć tylko te zakresy, których potrzebują do działania.

W projektach dodatków ustaw zakresy dodatku, aby mieć pewność, że dodatek używa najmniej restrykcyjnego zestawu zakresów. Określ zakresy w manifeście dodatku.

Więcej informacji znajdziesz w sekcji Zakresy.

Testowanie dodatku

Nieopublikowane dodatki możesz przetestować, instalując je. Po zainstalowaniu i autoryzacji użyj dodatku na swoim koncie, aby przetestować jego wygląd i działanie w aplikacjach hostowanych, które rozszerza. Sprawdź, czy dodatek działa zgodnie z oczekiwaniami w przypadku kontekstów i działań użytkownika.

Aby rozpocząć testowanie dodatku, zapoznaj się z tymi przewodnikami:

Publikowanie dodatku

Opublikowanie dodatku sprawi, że będzie on dostępny dla innych osób. Przed opublikowaniem sprawdź przegląd publikowanych zmian. Publikacja to złożony proces, który wymaga przygotowania.

Dodatki do Google Workspace są publikowane w Google Workspace Marketplace. Ogólnodostępne dodatki wymagają sprawdzenia aplikacji przed opublikowaniem.

Więcej informacji znajdziesz w artykule Publikowanie dodatku do Google Workspace.