Aby poprawić ogólne wrażenia 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 Ciebie 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 jego wydawcą. 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 w Google Cloud.
Rozszerz możliwości Google Workspace, a nie powielaj ich
Dodatki mają zapewniać nowe funkcje w aplikacji Google Workspace, którą rozszerzają, lub automatyzować złożone zadania. Dodatki, które tylko powielają funkcje już dostępne w aplikacji, lub nie wprowadzają znaczących ulepszeń w procesie pracy, prawdopodobnie nie przejdą sprawdzenia pod kątem opublikowania.
Zakresy powinny być wąskie
Podczas określania zakresów w sposób jawny zawsze wybieraj zestaw zakresów o jak najmniejszym zakresie. Na przykład nie proś o pełny dostęp do kalendarza użytkownika w zakresie https://www.googleapis.com/auth/calendar, jeśli dodatek potrzebuje tylko dostępu tylko do odczytu. W przypadku dostępu 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 używać bibliotek JavaScript po stronie klienta, takich jak jQuery, bez opóźnień.
Sprawdzone metody korzystania z dodatków do Google Workspace
Te sprawdzone metody dotyczą tylko dodatków 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 utworzyć obiekt i zwrócić go. Dzięki temu możesz szybko wygenerować ten obiekt, gdy trzeba odświeżyć interfejs użytkownika. 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 kart są renderowane jako elementy interfejsu, które można zwinąć, co ukrywa informacje przed użytkownikiem. Postaraj się uprościć swoje rozszerzenie i zapewnić użytkownikom dokładnie to, czego potrzebują.
Korzystanie z kart błędów
Tworzenie kart dla stanów błędów. Jeśli dodatek wygeneruje błąd, powinien wyświetlić kartę z informacjami o nim oraz instrukcjami, jak go naprawić (jeśli to możliwe). Jeśli na przykład Twój dodatek nie może połączyć się z usługą inną niż Google, ponieważ nie udało się uzyskać autoryzacji, wyświetl kartę z odpowiednim komunikatem i poproś użytkownika o potwierdzenie danych konta.
Pisanie testów i komunikatów testowych
Powinieneś dokładnie przetestować wszystkie utworzone przez siebie dodatki. Utwórz funkcje testowe, które tworzą karty i widżety za pomocą danych testowych, a potem sprawdź, czy obiekty zostały utworzone zgodnie z oczekiwaniami.
Jeśli używasz funkcji wywołania zwrotnego akcji, musisz zwykle utworzyć obiekt odpowiedzi. Aby sprawdzić, czy odpowiedzi są prawidłowo tworzone, możesz użyć takich instrukcji:
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 dla siebie 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 Twój dodatek rozszerza Gmaila, prawdopodobnie będziesz potrzebować kilku testowych e-maili i ich identyfikatorów wiadomości, aby sprawdzić, czy dodatek działa prawidłowo w przypadku różnych treści wiadomości. Identyfikator wiadomości możesz uzyskać, wyświetlając wiadomości za pomocą metody Gmail API Users.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 innych firm z Kalendarzem Google, postępuj zgodnie z tymi dodatkowymi wskazówkami:
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 długie wykonywanie tych funkcji może spowodować spowolnienie działania dodatku.
Użyj odpowiednich pól ConferenceData do danych konferencji
Podczas tworzenia obiektów ConferenceData możesz wypełnić je szczegółami dotyczącymi konferencji (kodów dostępu, numerów telefonów, pinów, identyfikatorów URI itp.). Pamiętaj, aby używać odpowiedniego pola EntryPoint. Nie umieszczaj tych informacji w polu ConferenceData
uwagi.
Nie dodawaj szczegółów rozmów wideo do wydarzenia w Kalendarzu Google
Dodatek nie musi dodawać informacji o konferencjach utworzonych przez inne firmy do opisu wydarzenia w Kalendarzu Google. Kalendarz Google robi to automatycznie, gdy jest to konieczne.