Aby utworzyć nowy dodatek do Google Workspace, postępuj zgodnie z tą ogólną procedurą:
- Skonfiguruj projekty dodatku i wybierz właściciela oraz współpracowników.
- Zaprojektuj wygląd i działanie dodatku.
- Skonfiguruj plik manifestu projektu dodatku lub zasób wdrożenia.
- Napisz kod określający wygląd i działanie dodatku.
- Zweryfikuj zakresy protokołu OAuth dodanego dodatku.
- Przetestuj dodatek w rozszerzanych aplikacjach hosta.
- Opublikuj dodatek.
Konfigurowanie projektów dodatku oraz wybieranie właścicieli 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ć dodatki, wybierz jedno konto użytkownika, które będzie właścicielem projektów, i zdecyduj, które inne konta będą współtwórcami. Właściciel projektów tworzy pliki projektu i powiązane z nimi ustawienia oraz nimi zarządza, a współpracownicy mogą pomóc w kodowaniu i testowaniu.
Projekty Apps Script
Pliki projektu Apps Script dodatku możesz utworzyć na dysku współdzielonym, dzięki czemu żadne konto nie będzie jedynym właścicielem. Umieszczenie pliku skryptu dodatku na dysku współdzielonym zapewnia dostęp do projektu skryptu wielu współpracownikom.
Gdy publikujesz dodatek, rolę wydawcy pełni jedno konto użytkownika. Konto wydawcy musi mieć uprawnienia do edycji projektu skryptu, ale nie musi być właścicielem.
Aby utworzyć projekt Apps Script, zobacz artykuł Projekty skryptu.
Projekty Google Cloud
Zalecamy dodanie współpracowników do projektu Cloud. Dzięki temu ktoś z Twojego zespołu ma zawsze dostęp do ustawień Cloud dodatku.
Aby utworzyć projekt Google Cloud, przeczytaj artykuł Tworzenie projektu Google Cloud.
Projektowanie wyglądu i działania dodatku
Zanim utworzysz dodatek, zdecyduj, jak ma wyglądać i jak powinien działać. Zastanów się, w jakich sytuacjach dodatek ma oferować rozwiązania. Zacznij od prostego projektu, aby zacząć pracę, a następnie dodaj więcej udoskonaleń.
Zapoznaj się z przewodnikiem po stylu dodatków do Google Workspace, aby dowiedzieć się, jak projektować środowisko użytkowników dodatków.
Konfigurowanie pliku manifestu projektu dodatku
W projektach Apps Script plik manifestu projektu to specjalny plik JSON. Określają różne szczegóły projektu, np. zależności bibliotek. W przypadku dodatków do Google Workspace plik manifestu zawiera też podstawowe informacje, których aplikacja hostująca potrzebuje do poprawnego wyświetlenia dodatku.
W sekcji Pliki manifestu znajdziesz szczegółowe informacje o konfigurowaniu pliku manifestu dodatku w Apps Script.
W miarę dodawania kodu i funkcji do dodatku edytuj plik manifestu, aby uzyskać wymagany wygląd i działanie dodatku.
Kodowanie dodatku
Musisz wdrożyć interfejs oparty na kartach. Skorzystaj z usługi Card Script lub jeśli piszesz w innym języku kodu, zwróć prawidłowo sformatowany plik JSON, aby interfejs renderował się jako karty.
Musisz też zaimplementować wszystkie funkcje aktywatora podane w pliku manifestu dodatku. Jeśli dodatek łączy się z usługą zewnętrzną nienależącą do Google przy użyciu OAuth, musisz też skonfigurować OAuth dla tej usługi.
Utwórz karty
Interfejs dodatku można zdefiniować, tworząc obiekty Card i wypełniając je widżetami. Funkcje aktywują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 możesz tworzyć karty za pomocą klasy CardBuilder. Każda karta wymaga CardHeader i co najmniej 1 CardSections. W każdej sekcji kart musisz wpisać poszczególne widżety, które tworzą interfejs dodatku. Widżety interakcji są zwykle powiązane z działaniami określającymi sposób interakcji.
Po dodaniu wszystkich sekcji i widżetów do karty za pomocą jej CardBuilder musisz wywołać metodę CardBuilder.build(), aby utworzyć odpowiedni obiekt Card.
Aby pobierać informacje, które są wyświetlane na tworzonych przez siebie kartach dodatków, możesz używać innych wbudowanych usług Apps Script, takich jak CalendarApp.
Możesz używać danych pobranych z usług innych niż Google.
Jeśli dodatki do Google Workspace wymagają dostępu do interfejsów API spoza Google, które wymagają protokołu OAuth, musisz skonfigurować tę usługę i połączyć się z nią. Więcej informacji znajdziesz w przewodniku na temat łączenia się z usługami innymi niż Google.
Zamówienie budowlane
Tworząc kartę, musisz budować od góry. To oznacza, że musisz używać tego kolejności konstrukcji:
- Utwórz widżet.
- Dodaj widżet do sekcji karty.
- Powtarzaj tę czynność, aż w sekcji kart pojawią się wszystkie widżety.
- Dodaj do karty sekcję karty.
Jest to wymagane, ponieważ gdy dodajesz widżet do karty lub sekcji karty, w rzeczywistości dodajesz kopię tego widżetu. Zmiany, które wprowadzisz w obiekcie widżetu po jego dodaniu, nie będą widoczne na końcowej karcie.
Działania uniwersalne
Aby udostępnić funkcję niezależną od kontekstu, możesz użyć działań uniwersalnych. Działania uniwersalne to pozycje 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 artykule Działania uniwersalne.
Weryfikowanie zakresów OAuth dodatków
Zakresy określają, jakie działania dodatek może wykonywać w imieniu użytkownika. Sprawdzoną metodą dla dodatków jest ustawienie zakresów tylko do działań, które muszą wykonać, aby mogły działać, i niczego więcej.
W projektach dodatków wyraźnie określ zakresy dodatków, aby mieć pewność, że dodatek używa zestawu zakresów o najmniejszych uprawnieniach. Zakresy, których używa dodatek, możesz określić w pliku manifestu dodatku.
Więcej informacji znajdziesz w artykule Zakresy.
Testowanie dodatku
Aby przetestować nieopublikowane dodatki, najpierw zainstaluj nieopublikowany dodatek. Po zainstalowaniu i autoryzowaniu dodatku możesz go używać na swoim koncie i testować jego wygląd i działanie w rozszerzanych aplikacjach hosta. Sprawdź, czy dodatek działa zgodnie z oczekiwaniami w przypadku kontekstów i działań użytkowników.
Więcej informacji znajdziesz w artykule Testowanie dodatków do Google Workspace.
Publikowanie dodatku
Opublikowanie dodatku spowoduje, że będzie on dostępny dla wszystkich – publicznie lub tylko dla użytkowników w Twojej domenie. Przed rozpoczęciem procesu 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. Dodatki dostępne publicznie muszą przejść sprawdzanie aplikacji przed ich opublikowaniem.
Więcej informacji znajdziesz w artykule Publikowanie dodatku do Google Workspace.