Na tej stronie znajdziesz omówienie projektowania, tworzenia i publikowania dodatków do Google Workspace. W tym przeglądzie omawiamy te kroki:
- Określ aplikacje Google Workspace, w których dodatek ma być dostępny dla użytkowników.
- Skonfiguruj projekty dodatku i wybierz właściciela oraz współpracowników.
- Zaprojektuj wygląd i zachowanie dodatku.
- Skonfiguruj plik manifestu projektu lub zasób wdrożenia dodatku.
- Napisać kod, który określi wygląd i działanie dodatku.
- Sprawdź zakresy uprawnień OAuth dodatku.
- przetestować dodatek w co najmniej 1 aplikacji Google Workspace;
- Opublikuj dodatek.
Wybieranie aplikacji hosta Google Workspace
Dodatki do Google Workspace możesz skonfigurować tak, aby wyświetlały się w tych aplikacjach hosta Google Workspace:
- Gmail
- Kalendarz Google
- 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.
Projekty Apps Script
Pliki projektu Apps Script dodatku możesz tworzyć na dysku współdzielonym, aby żadna pojedyncza osoba nie była 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 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 rozszerzenie powinno oferować rozwiązania. Najpierw zacznij od prostego projektu, a potem dodaj więcej szczegółów.
Aby uzyskać wskazówki dotyczące projektowania interfejsu użytkownika dodatku, zapoznaj się z przewodnikiem po stylach dodatków Google Workspace.
Konfigurowanie pliku manifestu projektu dodatku
W projektach Apps Script plik manifestu projektu to specjalny plik JSON. Zawiera ona różne szczegóły projektu, takie jak zależności od 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.
Dodając kod i funkcje do dodatku, edytuj manifest w taki sposób, aby uzyskać wymagany wygląd i działanie dodatku.
Kodowanie dodatku
Musisz wdrożyć interfejs oparty na karcie. 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 CardHeader i co najmniej 1 CardSections. Musisz wypełnić każdą sekcję karty osobnymi widżetami tworzącymi interfejs dodatku. Widoki interakcji są zwykle powiązane z działaniami, aby określić ich zachowanie.
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ż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
Tworząc kartę, musisz zacząć od doładowania. Oznacza to, że musisz użyć tej kolejności:
- Utwórz widżet.
- Dodaj widżet do sekcji karty.
- Powtarzaj te czynności, aż sekcja karty będzie zawierać wszystkie widżety.
- 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 widżecie po jego dodaniu nie zostaną odzwierciedlone na karcie.
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 może wykonywać w imieniu użytkownika. 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 pliku manifestu 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 kontekście kontekstów i działań użytkowników.
Więcej informacji znajdziesz w artykule Testowanie dodatków Google Workspace.
Opublikuj dodatek
Opublikowanie dodatku powoduje udostępnienie go innym – publicznie lub tylko użytkownikom 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 Google Workspace.