Tworzenie dodatków do Google Workspace

Na tej stronie znajdziesz omówienie procesu projektowania, tworzenia i publikowania dodatków do Google Workspace. W tym przeglądzie znajdziesz informacje o tych krokach:

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.

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

Wybieranie aplikacji hosta Google Workspace

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

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

Więcej informacji o tworzeniu aplikacji 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.

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.

Ostrzeżenie: jeśli nie dodasz współpracowników do projektów dodatków, konieczne jest przeniesienie na nich własności przed zamknięciem lub usunięciem konta właściciela. W przeciwnym razie możesz całkowicie utracić dostęp do kodu dodatku i jego ustawień.

Projekty Apps Script

Przed utworzeniem dodatku zapoznaj się z limitami i ograniczeniami dotyczącymi Apps Script, aby upewnić się, że projekt jest zgodny z tymi wytycznymi. Apps Script najlepiej sprawdza się w przypadku tworzenia prostych dodatków osobistych lub wewnętrznych dla niewielkiej grupy użytkowników. Jeśli planujesz utworzyć dodatek na dużą skalę, który będzie obsługiwać wielu użytkowników, wymagać niskich opóźnień lub pełnej kontroli nad infrastrukturą, rozważ opracowanie go w innym środowisku wykonawczym.

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

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

Zalecamy dodanie współpracowników do projektu w Cloud dodatku. Dzięki temu ktoś z Twojego zespołu będzie zawsze mieć dostęp do ustawień dodatku w chmurze.

Aby utworzyć projekt Google Cloud, przeczytaj artykuł Tworzenie projektu Google Cloud.

Projektowanie i konfigurowanie wyglądu oraz działania dodatku

Zanim zaczniesz tworzyć dodatek, zdecyduj, jak ma wyglądać i jak ma działać. Zastanów się, w jakich przypadkach dodatek powinien oferować rozwiązania. Zacznij od prostego projektu, aby najpierw zacząć pracę, a potem wprowadź więcej ulepszeń.

Wskazówka: zacznij od prostej karty na stronie głównej, a potem dodaj więcej widżetów, kart, elementów nawigacyjnych i innych funkcji. Możesz też rozważyć karty kontekstowe wywoływane przez działanie użytkownika w aplikacji hosta, takie jak otwarcie wątku wiadomości w Gmailu lub wydarzenia w Kalendarzu.

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

Konfigurowanie manifestu dodatku

Po zaprojektowaniu dodatku możesz zacząć wdrażać projekt w pliku manifestu dodatku. W pliku manifestu konfigurujesz większość elementów wyglądu i działania dodatku, w tym aplikacje hosta Google Workspace, które rozszerza dodatek.

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

W miarę dodawania kodu i funkcji do dodatku edytuj plik manifestu, aby uzyskać wymagany wygląd i działanie dodatku.

Konfigurowanie wyglądu i działania aplikacji Google Chat

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

Tworzenie dodatku

Musisz wdrożyć interfejs oparty na kartach dla dodatku. Użyj usługi kart Apps Script lub, jeśli piszesz w innym języku programowania, zwróć prawidłowo sformatowany kod JSON, aby interfejs renderował karty.

Musisz też wdrożyć wszystkie funkcje wywołujące określone w pliku manifestu dodatku. Jeśli dodatek łączy się z usługą innej firmy, która nie jest usługą Google, za pomocą protokołu OAuth, musisz również skonfigurować OAuth dla tej usługi.

Tworzenie kart

Interfejs użytkownika dodatku definiuje się przez tworzenie obiektówCard i wypełnianie ich widżetami. Funkcje wywołujące określone w pliku manifestu muszą zwracać pojedynczy obiekt Card lub tablicę obiektów Card reprezentujących 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 karty tworzy się za pomocą klasy CardBuilder. Każda karta wymaga CardHeader i co najmniej jednego CardSections. Każdą sekcję karty należy wypełnić poszczególnymi widżetami, które składają się na interfejs dodatku. Widżety interakcji są zwykle połączone z działaniami, aby określić ich zachowanie podczas interakcji.

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

Uwaga: jeśli po użyciu klas narzędziowych w usłudze kart nie wywołasz funkcji build(), wystąpią błędy typu. Funkcje reguł, np. muszą zwracać obiekty Card. Zwracanie obiektów CardBuilder zamiast tego spowoduje błąd.

Możesz używać innych wbudowanych usług Apps Script, takich jak CalendarApp, aby pobierać informacje do wyświetlania na kartach dodatku. Możesz używać danych pobranych z usług innych firm niż Google.

Jeśli dodatek potrzebuje dostępu do interfejsów API innych niż Google, które wymagają OAuth, musisz skonfigurować tę usługę i połączyć się z nią. Więcej informacji znajdziesz w przewodniku dotyczącym łączenia się z usługami innymi niż Google.

Zamówienie budowlane

Podczas tworzenia karty musisz zaczynać od góry. Oznacza to, że musisz użyć 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.

Jest to wymagane, ponieważ gdy dodajesz widżet do karty lub sekcji karty, w rzeczywistości dodajesz jego kopię. Żadne zmiany wprowadzone w obiekcie widżetu po jego dodaniu nie zostaną odzwierciedlone na karcie końcowej.

Ostrzeżenie: widżet dodawaj do karty lub sekcji karty dopiero po zakończeniu jej tworzenia. Sekcję karty dodawaj do karty dopiero po jej całkowitym wypełnieniu widżetami. Nie zmieniaj widżetów ani sekcji po ich dodaniu. Jeśli chcesz wprowadzić zmiany w dodanym widżecie, musisz ponownie utworzyć sekcję lub kartę, do której został on dodany.

Działania uniwersalne

Możesz używać 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 tego, która karta jest wyświetlana. Wszystkie zdefiniowane działania uniwersalne są zawsze widoczne w menu karty dodatku.

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

Sprawdzanie zakresów OAuth dodatku

Zakresy określają, jakie działania dodatek może wykonywać w imieniu użytkownika. Zgodnie z dobrymi praktykami dodatki powinny mieć tylko zakresy działań, które są niezbędne do ich działania.

W projektach dodatków jawnie ustaw zakresy dodatku, aby mieć pewność, że dodatek używa najmniej restrykcyjnego zestawu zakresów. Zakresy, których używa dodatek, określasz w pliku manifestu dodatku.

Więcej informacji znajdziesz w sekcji Zakresy.

Testowanie dodatku

Nieopublikowane dodatki możesz przetestować, instalując je. Po zainstalowaniu i autoryzacji możesz używać dodatku na swoim koncie oraz testować jego wygląd i działanie w aplikacjach hosta, które rozszerza. Sprawdź, czy dodatek działa zgodnie z oczekiwaniami w kontekście działań użytkownika.

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

• Testowanie i debugowanie dodatków do Google Workspace utworzonych za pomocą Apps Script
• Testowanie i debugowanie dodatków HTTP do Google Workspace
• Testowanie funkcji interaktywnych aplikacji Google Chat

Publikowanie dodatku

Opublikowanie dodatku sprawi, że będzie on dostępny dla innych osób – publicznie lub tylko dla użytkowników w Twojej domenie. Zanim rozpoczniesz proces publikowania, zapoznaj się z omówieniem publikacji. Publikacja to złożony proces, który wymaga przygotowania i czasu.

Dodatki do Google Workspace są publikowane w Google Workspace Marketplace. Publicznie dostępne dodatki muszą przejść weryfikację, zanim zostaną opublikowane.

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