Aby zwiększyć ogólny komfort użytkowników, postępuj zgodnie z tymi wskazówkami dotyczącymi projektowania dodatków.
Ogólne sprawdzone metody
Zachęcamy do stosowania tych sprawdzonych metod w przypadku wszystkich tworzonych przez siebie dodatków.
Zanim zaczniesz, sprawdź, kto jest właścicielem dodatku
Dodatki są definiowane przez projekty Apps Script, które muszą należeć do konkretnego konta lub być umieszczone na dysku współdzielonym. Zanim zaczniesz kodować dodatek, określ, które konto powinno być właścicielem projektu, a które będzie pełnić rolę wydawcy. Określ też, które konta mają działać jako współpracownicy, i upewnij się, że mają one dostęp do projektu skryptu i powiązanego z nim projektu Google Cloud.
Rozszerz możliwości Google Workspace, a nie powielaj ich
Dodatki mają zapewniać nowe funkcje aplikacji Google Workspace, które rozszerzają, lub automatyzować złożone zadania. Dodatki, które jedynie powielają funkcje już dostępne w aplikacji, lub te, które nie wprowadzają znaczących ulepszeń w procesie, prawdopodobnie nie przejdą sprawdzenia pod kątem publikacji.
Zakresy powinny być wąskie
Podczas określania zakresów zawsze wybieraj możliwie najbardziej restrykcyjne zakresy. Na przykład nie proś o pełny dostęp do kalendarza użytkownika z zakresem https://www.googleapis.com/auth/calendar, jeśli dodatek potrzebuje tylko dostępu tylko do odczytu. Aby uzyskać dostęp tylko do odczytu, użyj zakresu https://www.googleapis.com/auth/calendar.readonly.
Unikaj nadmiernego polegania na bibliotekach
Korzystanie z bibliotek Apps Script może spowodować, że dodatek będzie działać wolniej niż wtedy, gdy cały kod Apps Script byłby zawarty w pojedynczym projekcie skryptu. Biblioteki Apps Script działają w dodatkach, ale ich używanie może spowodować spadek wydajności. Unikaj umieszczania w projekcie niepotrzebnych bibliotek i zastanów się, jak ograniczyć ich użycie w dodatku.
Opóźnienie opisane powyżej dotyczy tylko projektów Apps Script używanych jako biblioteki po stronie serwera. Możesz swobodnie korzystać z bibliotek JavaScript po stronie klienta, takich jak jQuery, bez opóźnień.
Sprawdzone metody korzystania z dodatków do Google Workspace
Poniższe sprawdzone metody dotyczą tylko dodatków do Google Workspace i korzystania z usługi kart.
Użyj tylko kilku kart
Jeśli wtyczka używa zbyt wielu kart, konfiguracja nawigacji staje się skomplikowana i trudna do zarządzania.
Nie twórz więcej kart, niż jest to konieczne.
Korzystanie z funkcji tworzenia widżetów
Podczas pisania kodu, który tworzy Card lub inne złożone obiekty interfejsu użytkownika, rozważ umieszczenie tego kodu w osobnej funkcji. Funkcja tworzenia powinna tylko tworzyć obiekt i zwracać go. Dzięki temu możesz szybko wygenerować ten obiekt, gdy trzeba odświeżyć interfejs. Pamiętaj, aby wywołać build() po użyciu klas kreatora w usłudze kart.
Proste karty
Jeśli dana karta ma zbyt wiele widżetów, może zajmować zbyt dużo miejsca na ekranie i stać się mniej przydatna. Duże sekcje karty są renderowane jako elementy interfejsu, które można zwinąć, co ukrywa informacje przed użytkownikiem. Postaraj się uprościć swój dodatek i zapewnij użytkownikom dokładnie to, czego potrzebują.
Korzystanie z kart błędów
Tworzenie kart w przypadku błędów. Jeśli dodatek wyświetla błąd, powinien wyświetlić kartę z informacjami o błędzie i instrukcjami jego naprawienia (jeśli to możliwe). Jeśli na przykład wtyczka nie może połączyć się z usługą inną niż Google, ponieważ autoryzacja się nie udała, wyświetl kartę z odpowiednim komunikatem i poproś użytkownika o potwierdzenie używanych informacji o koncie.
Pisanie testów i komunikatów testowych
Powinieneś dokładnie przetestować wszystkie utworzone przez siebie dodatki. Utwórz testowe funkcje, które tworzą karty i widżety za pomocą danych testowych, a potem sprawdź, czy obiekty są tworzone zgodnie z oczekiwaniami.
Podczas korzystania z funkcji wywołania zwrotnego akcji zwykle musisz utworzyć obiekt odpowiedzi. Aby sprawdzić, czy odpowiedzi są prawidłowo konstruowane, możesz użyć takich instrukcji jak ta:
Logger.log(response.printJson());
Uruchom testowe funkcje utworzone bezpośrednio w edytorze Apps Script, korzystając z menu Uruchom. Gdy będziesz mieć działający, odpowiedni dodatek, zainstaluj jego nieopublikowaną wersję, aby go przetestować.
Używaj danych testowych odpowiednich dla każdej aplikacji hosta, do której rozszerza się dodatek. Jeśli na przykład dodatek rozszerza Gmaila, prawdopodobnie będziesz potrzebować kilku testowych e-maili i ich identyfikatorów wiadomości, aby sprawdzić, czy dodatek działa zgodnie z oczekiwaniami w przypadku różnych treści wiadomości. Identyfikator wiadomości możesz uzyskać, wyświetlając wiadomości za pomocą metody Gmail APIusers.messages.list lub korzystając z usługi Gmail w Apps Script.
Sprawdzone metody dotyczące konferencji w kalendarzu
Jeśli Twój dodatek integruje opcje rozmów wideo w kalendarzu innej firmy z Kalendarzem Google, postępuj zgodnie z tymi dodatkowymi sprawdzonymi metodami:
Utrzymuj światło onCreateFunction
Każda funkcja onCreateFunction zdefiniowana w pliku manifestu jest wywoływana synchronicznie, gdy użytkownik próbuje utworzyć rozwiązanie konferencyjne danego typu. Upewnij się, że te funkcje wykonują tylko minimalną ilość pracy niezbędną do utworzenia konferencji. Zbyt duża liczba funkcji może spowodować spowolnienie działania dodatku.
Do danych konferencji używaj odpowiednich pól ConferenceData
Podczas tworzenia obiektów ConferenceData możesz wypełnić je szczegółami dotyczącymi konferencji (np. kodami dostępu, numerami telefonów, pinami, identyfikatorami URI). Pamiętaj, aby użyć odpowiedniego pola EntryPoint. Nie umieszczaj tych informacji w polu ConferenceData z notatkami.
Nie dodawaj szczegółów rozmów wideo do wydarzenia w Kalendarzu
Dodatek nie musi zawierać informacji o konferencjach utworzonych przez inne firmy w opisie wydarzenia w Kalendarzu. Kalendarz robi to automatycznie, gdy jest to konieczne.