Aby utworzyć nowy dodatek do Google Workspace, wykonaj te ogólne czynności:
- 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.
- Wpisz kod określający wygląd i działanie dodatku.
- Sprawdź zakresy OAuth dodatku.
- Przetestuj dodatek w rozszerzonych aplikacjach hosta.
- Opublikuj dodatek.
Konfigurowanie projektów dodatku oraz wybieranie właściciela i współpracowników
Jeśli tworzysz dodatek w Apps Script, utworzysz zarówno projekt Apps Script, jak i projekt Google Cloud. Jeśli tworzysz dodatek w języku innym niż Apps Script, wystarczy utworzyć projekt Google Cloud.
Zanim zaczniesz opracowywać dodatki, wybierz pojedyncze konto użytkownika, które będzie właścicielem projektów i zdecyduj, które z pozostałych kont są współpracownikami. Właściciel projektów tworzy pliki projektów i powiązane z nimi ustawienia oraz nimi zarządza, natomiast współpracownicy mogą pomóc w kodowaniu i testowaniu.
Projekty Apps Script
Możesz utworzyć pliki projektu Apps Script na dodatku na dysku współdzielonym, dzięki czemu każde konto nie będzie jedynym właścicielem. Umieszczenie pliku skryptu dodatkowego na dysku współdzielonym pozwala łatwo zapewnić dostęp do projektu skryptu wielu współpracownikom.
Gdy opublikujesz dodatek, konto wydawcy będzie działać jako jedno konto użytkownika. Konto wydawcy musi mieć uprawnienia do edycji projektu skryptu, ale nie musi być właścicielem.
Projekty Google Cloud
Zalecamy dodanie współpracowników do projektu Cloud dodatku. Dzięki temu ktoś w Twoim zespole zawsze ma dostęp do ustawień chmury dodatku.
Projektowanie wyglądu i działania dodatku
Zanim zaczniesz tworzyć dodatek, ustal, jak ma on wyglądać i jak powinien wyglądać. Zastanów się, w jakich przypadkach dodatek powinien podejmować rozwiązania. Zacznij od prostego projektu, a potem dodaj więcej poprawek.
Wskazówki na temat projektowania interfejsu dodatku znajdziesz w przewodniku po stylu dodatku do Google Workspace.
Skonfiguruj plik manifestu projektu dodatku
W projektach Apps Script manifest projektu to specjalny plik JSON. Określa różne szczegóły projektu, np. zależności biblioteki. Plik manifestu dodatków do Google Workspace zawiera też podstawowe informacje potrzebne do poprawnego wyświetlania dodatku.
Szczegółowe informacje o tym, jak skonfigurować plik manifestu dodatku w Apps Script, znajdziesz w sekcji Pliki manifestu.
Gdy chcesz dodać kod i funkcje dodatku, edytuj plik manifestu, aby utworzyć wygląd i działanie dodatku.
Kodowanie dodatku
Musisz wdrożyć interfejs oparty na karcie. Użyj usługi kart Apps Script lub jeśli piszesz w innym języku kodu, zwróć prawidłowo sformatowany format JSON, aby interfejs mógł być wyświetlany jako karty.
Musisz też zaimplementować wszystkie funkcje aktywatorów określone w pliku manifestu dodatku. Jeśli dodatek łączy się z usługą innej firmy za pomocą protokołu OAuth, musisz też skonfigurować w niej OAuth.
Tworzenie kart
Dodatkowy interfejs definiuje się, tworząc obiekty Card i wypełniając je widżetami. Funkcje aktywatora 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 karty należy umieścić osobne widżety składające się na interfejs dodatku. Widżety interakcji są zwykle powiązane z działaniami definiującymi ich działanie.
Po dodaniu wszystkich sekcji i widżetów na karcie za pomocą jej elementu CardBuilder musisz wywołać metodę CardBuilder.build(), by utworzyć odpowiadający jej obiekt Card.
Aby pobrać informacje do wyświetlenia na dodatkowych kartach, możesz użyć innych wbudowanych usług Apps Script, takich jak CalendarApp. Możesz użyć danych pobranych z usług innych firm.
Jeśli 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 po łączeniu z usługami innymi niż Google.
Zamówienie budowlane
Tworząc kartę, musisz budować od góry. Musisz użyć tego zamówienia:
- Utwórz widżet.
- Dodaj widżet do sekcji karty.
- Powtarzaj tę czynność, aż w sekcji karty pojawią się wszystkie jej widżety.
- Dodaj do niej sekcję karty.
Jest to wymagane, ponieważ gdy dodajesz widżet do sekcji karty, właściwie dodajesz jego kopię. Zmiany wprowadzone w obiekcie widżetu po jego dodaniu nie zostaną odzwierciedlone na ostatniej karcie.
Uniwersalne działania
Aby korzystać z funkcji niezależnych od kontekstu, możesz używać działań uniwersalnych. Uniwersalne działania to pozycje menu dostępne w interfejsie dodatku, niezależnie od tego, która karta jest aktualnie wyświetlana. Wszystkie zdefiniowane działania uniwersalne są zawsze widoczne w menu karty dodatku.
Więcej informacji znajdziesz w sekcji Działania uniwersalne.
Weryfikowanie zakresów OAuth dodatku
Zakresy określają, jakie działania może wykonywać dodatek w imieniu użytkownika. Sprawdzoną metodą dla dodatków jest dodanie zakresów tylko do czynności, których muszą one używać w ramach funkcji kolejności.
W projektach dodatków wyraźnie ustaw zakresy dodatków, aby mieć pewność, że dodatek korzysta z najmniejszych zakresów. Definiujesz zakresy używane przez dodatek w pliku manifestu.
Więcej informacji znajdziesz w artykule Zakresy.
Testowanie dodatku
Aby przetestować nieopublikowane dodatki, musisz najpierw zainstalować nieopublikowany dodatek. Po zainstalowaniu i autoryzacji możesz używać dodatku na swoim koncie i testować jego działanie i sposób działania w aplikacjach hosta, które jest rozszerzane. Sprawdź, czy dodatek zachowuje się zgodnie z oczekiwaniami i kontekstem.
Więcej informacji znajdziesz w artykule Testowanie dodatków do Google Workspace.
Publikowanie dodatku
Gdy opublikujesz dodatek, zostanie on udostępniony innym użytkownikom, zarówno publicznie, jak i tylko użytkownikom w Twojej domenie. Zanim rozpoczniesz proces publikowania, przeczytaj omówienie 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ą zostać sprawdzone przed opublikowaniem.
Więcej informacji znajdziesz w artykule Publikowanie dodatku Google Workspace.
Przykład dodatku Google Workspace
Aby ułatwić zrozumienie, jak skonstruowane są dodatki do Google Workspace, krótkie informacje o kotach w Google Workspace pokazują, jak stworzyć prosty dodatek do Google Workspace, w tym strony główne, nawigację na kartach i połączenia z usługą innej firmy. Po zakończeniu samouczka możesz zainstalować dodatek i poeksperymentować z kodem.