Jeśli chcesz utworzyć nowy dodatek do Google Workspace, wykonaj 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 lub zasób wdrożenia dodatku.
- Napisz kod określający wygląd i działanie dodatku.
- Sprawdź zakresy protokołu OAuth dodatku.
- Przetestuj dodatek w rozszerzanych aplikacjach hosta.
- Opublikuj dodatek.
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, wystarczy, że utworzysz projekt Google Cloud.
Zanim zaczniesz tworzyć dodatek, wybierz 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 zarządza nimi, a współpracownicy mogą pomagać w kodowaniu i testowaniu.
Projekty Apps Script
Pliki projektów Apps Script dla dodatku możesz tworzyć na dysku współdzielonym, dzięki czemu żadne z kont nie ma wyłącznej własności. Umieszczenie pliku skryptu dodatku na dysku współdzielonym daje pewność, że wielu współpracowników ma dostęp do projektu skryptu.
Gdy publikujesz dodatek, jako wydawca działa jedno konto użytkownika. Konto wydawcy musi mieć uprawnienia do edycji projektu skryptu, ale nie musi być jego właścicielem.
Aby dowiedzieć się, jak utworzyć projekt Apps Script, zobacz artykuł na temat projektów skryptów.
Projekty Google Cloud
Zalecamy dodanie współpracowników do projektu Cloud dodatku. Dzięki temu członkowie Twojego zespołu będą mieli zawsze dostęp do ustawień Cloud dodatku.
Aby utworzyć projekt Google Cloud, zapoznaj się z sekcją Tworzenie projektu Google Cloud.
Projektowanie wyglądu i działania dodatku
Zanim zaczniesz tworzyć dodatek, zdecyduj, jak ma wyglądać i jak ma działać. Zastanów się, w jakich sytuacjach dodatek powinien zapewniać rozwiązania. Najpierw trzeba zacząć od prostego projektu, a potem dodać kolejne ulepszenia.
Wskazówki dotyczące projektowania dodatków do Google Workspace znajdziesz w przewodniku stylistycznym na temat dodatków do Google Workspace.
Skonfiguruj plik manifestu projektu dodatku
W projektach Apps Script plik manifestu projektu to specjalny plik JSON. Zawiera różne szczegóły projektu, takie jak zależności bibliotek. W przypadku dodatków do Google Workspace plik manifestu zawiera też podstawowe informacje, których aplikacja hosta potrzebuje do prawidłowego wyświetlania dodatku.
Szczegółowe informacje o konfigurowaniu pliku manifestu dodatku w Apps Script znajdziesz w sekcji Pliki manifestu.
W trakcie dodawania kodu i funkcji do dodatku edytuj plik manifestu, aby uzyskać jego wygląd i działanie.
Kodowanie dodatku
Musisz wdrożyć interfejs oparty na karcie. Użyj usługi kart Apps Script, a jeśli piszesz w innym języku kodu, zwróć odpowiednio sformatowany plik JSON, aby interfejs wyświetlał się jako karty.
Musisz też zaimplementować wszystkie funkcje aktywatorów określone w pliku manifestu dodatku. Jeśli Twój dodatek łączy się z usługą innej firmy niż Google przy użyciu protokołu OAuth, musisz też skonfigurować OAuth dla tej usługi.
Karty tworzenia
Aby zdefiniować interfejs dodatku, należy utworzyć obiekty Card i wypełnić 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żytkowników.
W Apps Script możesz tworzyć karty za pomocą klasy CardBuilder. Każda karta wymaga CardHeader i co najmniej 1 CardSections. Musisz wypełnić każdą sekcję karty osobnymi widżetami, które składają się na interfejs dodatku. Widżety interakcji są zwykle powiązane z działaniami, które definiują ich interakcje.
Po dodaniu do karty wszystkich sekcji i widżetów za pomocą obiektu CardBuilder musisz wywołać CardBuilder.build(), by utworzyć odpowiedni obiekt Card.
Możesz użyć innych wbudowanych usług Apps Script, takich jak CalendarApp, aby pobrać informacje do wyświetlenia na utworzonych kartach dodatków.
Możesz używać danych pobranych z usług innych niż Google.
Jeśli Twoje dodatki do Google Workspace wymagają dostępu do interfejsów API innych niż 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 innych niż Google.
Zlecenie budowy
Tworząc kartę, musisz zacząć od doładowania. Musisz użyć tej kolejności konstrukcji:
- Utwórz widżet.
- Dodaj widżet do sekcji karty.
- Powtarzaj czynność, aż w sekcji karty będą widoczne wszystkie widżety.
- Dodaj do karty sekcję karty.
Jest to wymagane, ponieważ dodając widżet do karty lub sekcji karty, dodajesz kopię tego widżetu. Wszelkie zmiany wprowadzone w obiekcie widżetu po jego dodaniu nie zostaną odzwierciedlone na ostatecznej karcie.
Działania uniwersalne
Możesz użyć działań uniwersalnych, aby udostępnić funkcje niezależne od kontekstu. Działania uniwersalne to pozycje menu dostępne w interfejsie dodatku, niezależnie od tego, jaka 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 dodatkowych zakresów protokołu OAuth
Zakresy określają, jakie działania dodatek może wykonywać w imieniu użytkownika. Sprawdzoną metodą w przypadku dodatków jest tworzenie zakresów tylko dla działań, które muszą występować w ramach funkcji kolejności, i żadnych innych.
W projektach dodatkowych wyraźnie ustaw zakresy dodatków, aby mieć pewność, że dodatek będzie używał najmniej restrykcyjnego zestawu zakresów. Zakresy używane przez dodatek określasz w pliku manifestu dodatku.
Więcej informacji znajdziesz w sekcji Zakresy.
Testowanie dodatku
Aby przetestować nieopublikowane dodatki, najpierw zainstaluj je. Po zainstalowaniu i autoryzowaniu możesz użyć dodatku na swoim koncie i przetestować jego wygląd oraz działanie w rozszerzonych aplikacjach hosta. Sprawdź, czy dodatek działa zgodnie z oczekiwaniami w kontekście kontekstów i działań użytkowników.
Więcej informacji znajdziesz w artykule Testowanie dodatków do Google Workspace.
Opublikuj dodatek
Opublikowanie dodatku powoduje udostępnienie go innym – publicznie lub tylko użytkownikom w Twojej domenie. Przed rozpoczęciem procesu publikowania zapoznaj się z omówieniem publikacji. Publikacja to skomplikowany proces, który wymaga przygotowania i czasu.
Dodatki do Google Workspace zostały opublikowane w Google Workspace Marketplace. Publicznie dostępne dodatki muszą ukończyć weryfikację aplikacji przed ich opublikowaniem.
Więcej informacji znajdziesz w artykule Publikowanie dodatku do Google Workspace.