Tworzenie dodatków do Google Workspace

Na tej stronie znajdziesz omówienie projektowania, tworzenia i publikowania dodatków do Google Workspace. W tym przeglądzie omawiamy te kroki:

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 uprawnień OAuth dodatku.
6. przetestować dodatek w co najmniej 1 aplikacji Google Workspace;
7. Opublikuj dodatek.

Wybieranie aplikacji hosta Google Workspace

Dodatki Google Workspace możesz skonfigurować tak, aby były widoczne w tych aplikacjach hosta Google Workspace:

• Gmail
• Kalendarz Google
• Google Chat (wersja dla programistów)
• Dokumenty Google
• Dysk Google
• 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, musisz utworzyć projekt Apps Script i projekt Google Cloud. Jeśli dodatek tworzysz w języku innym niż Apps Script, musisz utworzyć tylko projekt Google Cloud.

Zanim zaczniesz tworzyć dodatki, wybierz 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 zarządza nimi oraz powiązanymi ustawieniami, a współpracownicy mogą pomagać w kodowaniu i testowaniu.

Ostrzeżenie: jeśli nie dodasz współpracowników do projektów dodatków, koniecznie przenieś na nich prawo 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 i ustawień dodatku.

Projekty Apps Script

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

Gdy publikujesz dodatek, konto pojedynczego użytkownika działa jako wydawca. 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 Google Cloud, w którym znajduje się ten dodatek. Dzięki temu inna osoba z Twojego zespołu będzie mieć zawsze dostęp do ustawień usługi 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 jak ma działać. Zastanów się, w jakich sytuacjach rozszerzenie powinno oferować rozwiązania. Najpierw zacznij od prostego projektu, a potem dodaj więcej szczegółów.

Wskazówka: zacznij od prostej karty na stronie głównej, a potem dodaj więcej widżetów, kart, elementów nawigacji i innych elementów. 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.

Aby uzyskać wskazówki dotyczące projektowania interfejsu użytkownika dodatku, zapoznaj się z przewodnikiem po stylach dodatków Google Workspace.

Konfigurowanie pliku manifestu dodatku

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

Szczegółowe informacje znajdziesz w artykule Pliki manifestu dodatku Google Workspace.

Dodając kod i funkcje do dodatku, edytuj manifest w taki sposób, aby uzyskać wymagany wygląd i działanie dodatku.

Konfigurowanie wyglądu i działania aplikacji Google Chat

Wersja dla deweloperów: dostępna w ramach programu Google Workspace Developer Preview, który zapewnia wcześniejszy dostęp do niektórych funkcji.

Jeśli zaprojektujesz dodatek rozszerzający Google Chat, musisz użyć interfejsu Google Chat API, aby skonfigurować wygląd i zachowanie aplikacji Google Chat. Aby dowiedzieć się, jak to zrobić, przeczytaj artykuł Konfigurowanie aplikacji Google Chat.

Tworzenie dodatku

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

Musisz też zaimplementować wszystkie funkcje wyzwalające określone w pliku manifestu dodatku. Jeśli wtyczka łączy się z usługą innej firmy za pomocą protokołu OAuth, musisz też skonfigurować OAuth dla tej usługi.

karty konstrukcyjne,

Interfejs użytkownika dodatku definiujesz, tworząc obiekty Card i wypełniając je widżetami. Funkcje wywołania określone w pliku manifestu muszą zwracać pojedynczy obiekt Card lub tablicę obiektów Card reprezentujących różne „strony” interfejsu dodatku. Twój dodatek może też tworzyć i wyświetlać nowe karty w odpowiedzi na działania użytkownika.

W Apps Script karty tworzysz za pomocą klasy CardBuilder. Każda karta wymaga CardHeaderi co najmniej CardSections. Każdą sekcję karty należy wypełnić poszczególnymi widżetami, które tworzą interfejs dodatku. Widoki interakcji są zwykle powiązane z działaniami, aby określić ich zachowanie.

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

Uwaga: niewywołanie metody build() po użyciu klas konstruktora w usłudze kart powoduje błędy typu. Na przykład funkcje reguł muszą zwracać obiekty Card. Zwracanie obiektów CardBuilder powoduje błąd.

Możesz używać innych wbudowanych usług Apps Script, takich jak CalendarApp, aby pobierać informacje do wyświetlania na tworzonych przez siebie kartach dodatków. Możesz używać danych pobieranych z usług innych 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 z nią połączyć. Więcej informacji znajdziesz w przewodniku Połączenie z usługami innymi niż Google.

Zamówienie budowy

Podczas tworzenia karty musisz zacząć od góry. Oznacza to, że musisz użyć tej kolejności:

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

Jest to konieczne, ponieważ dodając widżet do karty lub sekcji karty, kopiujesz ten widżet. Wszelkie zmiany wprowadzone w obiekcie widżetu po jego dodaniu nie zostaną odzwierciedlone na karcie końcowej.

Ostrzeżenie: widżet dodaj do karty lub sekcji karty dopiero po jej utworzeniu. Dodaj sekcję karty dopiero po wypełnieniu jej widżetami. Po dodaniu widżetów lub sekcji nie zmieniaj ich. Jeśli chcesz wprowadzić zmiany w dodanym widżecie, musisz ponownie utworzyć sekcję lub kartę, do której zostało dodane.

Działania uniwersalne

Aby zapewnić działanie niezależnie od kontekstu, możesz używać działań uniwersalnych. 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 zawsze są widoczne w menu karty dodatku.

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

Sprawdź zakresy OAuth dodatku

Zakresy określają, jakie działania w imieniu użytkownika może wykonywać dodatek. Najlepiej, jeśli dodatki mają tylko te zakresy, których potrzebują do działania.

W projektach dodatków wyraźnie określ zakresy dodatków, aby mieć pewność, że dodatek używa możliwie najmniej restrykcyjnych zakresów. Zakresy, których używa dodatek, określasz w manifest dodatku.

Więcej informacji znajdziesz w sekcji Zakresy.

Testowanie dodatku

Nieopublikowane dodatki możesz testować, najpierw instalując nieopublikowany dodatek. Po zainstalowaniu i autoryzowaniu dodatku możesz go używać na swoim koncie oraz testować jego wygląd i działanie w aplikacjach hosta, do których się rozszerza. Sprawdź, czy dodatek działa zgodnie z oczekiwaniami w różnych kontekstach i w reakcji na różne działania użytkowników.

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

• Testowanie i debugowanie dodatków Google Workspace do Apps Script
• Testowanie i debugowanie wtyczek Google Workspace HTTP
• Testowanie funkcji interaktywnych w aplikacjach Google Chat

Publikowanie dodatku

Opublikowanie dodatku spowoduje, że będzie on dostępny dla innych użytkowników, albo publicznie, albo tylko dla użytkowników w Twojej domenie. Zanim rozpoczniesz proces publikowania, zapoznaj się z omówieniem publikowania. Publikowanie jest złożonym procesem, który wymaga przygotowania i czasu.

Dodatki Google Workspace są publikowane w Google Workspace Marketplace. Dodatki dostępne publicznie muszą przejść sprawdzenie aplikacji, zanim zostaną opublikowane.

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