Zadbaj o lepszy komfort użytkowania, stosując się do tych wskazówek dotyczących projektowania dodatków.
Ogólne sprawdzone metody
Zachęcamy do stosowania tych sprawdzonych metod w przypadku wszystkich tworzonych dodatków.
Określ własność dodatku przed rozpoczęciem
Dodatki są definiowane przez projekty Apps Script, które muszą należeć do określonego konta lub znajdować się na dysku współdzielonym. Zanim zaczniesz pisać kod dodatku, 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ą pełnić rolę współpracowników, i upewnij się, że mają one dostęp do projektu skryptu i powiązanego z nimprojektu Google Cloud.
Rozszerzaj Google Workspace, nie kopiuj go
Dodatki mają na celu dodawanie nowych funkcji do aplikacji Google Workspace, które rozszerzają, lub automatyzowanie złożonych zadań. Dodatki, które po prostu powielają funkcje już dostępne w aplikacji lub nie wprowadzają znaczących ulepszeń w przepływie pracy prawdopodobnie nie przejdą weryfikacji dodatku i nie zostaną opublikowane.
Ogranicz zakresy
Podczas definiowania zakresów
jawnie, zawsze wybieraj
najmniej restrykcyjny zestaw zakresów. Na przykład jeśli dodatek potrzebuje tylko dostępu do odczytu, nie proś o pełny dostęp do Kalendarza użytkownika za pomocą zakresu https://www.googleapis.com/auth/calendar. 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 znajduje się w jednym projekcie skryptu. Biblioteki Apps Script działają w dodatkach, ale ich używanie może spowodować spadek wydajności. Unikaj dodawania do projektu niepotrzebnych bibliotek i zastanów się, jak zmniejszyć zależność dodatku od nich.
Opisane powyżej opóźnienie 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 obawy o opóźnienie.
Sprawdzone metody dotyczące dodatków do Google Workspace
Te sprawdzone metody dotyczą tylko dodatków do Google Workspace i korzystania z usługi Card.
Używaj tylko kilku kart
Jeśli dodatek używa zbyt wielu kart, konfiguracja nawigacji staje się złożona i trudna do zarządzania.
Unikaj tworzenia większej liczby kart niż jest to konieczne.
Używaj funkcji tworzenia widżetów
Podczas pisania kodu, który tworzy a
Card lub inne złożone obiekty interfejsu,
rozważ umieszczenie tego kodu w osobnej funkcji. Ta funkcja tworzenia powinna tylko tworzyć obiekt i go zwracać. Dzięki temu możesz szybko ponownie wygenerować ten obiekt, gdy trzeba odświeżyć interfejs. Pamiętaj, aby po użyciu
klas konstruktora w usłudze Card service wywołać funkcję build().
Uprość 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 zwijane elementy interfejsu, co ukrywa informacje przed użytkownikiem. Staraj się uprościć dodatek i udostępniać dokładnie to, czego potrzebuje użytkownik, i nic więcej.
Używaj kart błędów
Twórz karty dla warunków błędów. Jeśli dodatek wygeneruje błąd, powinien wyświetlić kartę z informacjami o błędzie i instrukcjami, jak go naprawić, jeśli to możliwe. Jeśli na przykład dodatek nie może połączyć się z usługą inną niż Google, ponieważ autoryzacja nie powiodła się, wyświetl kartę z tą informacją i poproś użytkownika o sprawdzenie używanych informacji o koncie.
Pisanie testów i wiadomości testowych
Wszystkie tworzone dodatki należy dokładnie przetestować. Utwórz funkcje testowe, które tworzą karty i widżety za pomocą danych testowych, a następnie sprawdź, czy obiekty są tworzone zgodnie z oczekiwaniami.
W przypadku korzystania z funkcji wywołania zwrotnego działania zwykle trzeba utworzyć obiekt odpowiedzi. Aby sprawdzić, czy odpowiedzi są tworzone prawidłowo, możesz użyć takich instrukcji jak te:
Logger.log(response.printJson());
Uruchamiaj utworzone funkcje testowe bezpośrednio z edytora Apps Script za pomocą menu Uruchom. Gdy masz działający dodatek, zainstaluj jego nieopublikowaną wersję, aby móc go przetestować.
Używaj danych testowych odpowiednich dla każdej aplikacji hosta, którą rozszerza dodatek. Jeśli na przykład dodatek rozszerza Gmaila, prawdopodobnie będziesz potrzebować kilku testowych e-maili i ich identyfikatorów wiadomości, aby mieć pewność, że dodatek działa zgodnie z oczekiwaniami w przypadku różnych treści wiadomości. Identyfikator wiadomości możesz uzyskać, wyświetlając listę
wiadomości za pomocą metody interfejsu Gmail API
users.messages.list
, lub korzystając z usługi Gmail Apps Script.
Sprawdzone metody dotyczące rozmów wideo w Kalendarzu
Jeśli dodatek integruje opcje rozmów wideo w Kalendarzu Google innych firm, postępuj zgodnie z tymi dodatkowymi sprawdzonymi metodami:
Utrzymaj onCreateFunction jasność
Każda funkcja
onCreateFunction
zdefiniowana w pliku manifestu jest wywoływana synchronicznie, gdy użytkownik próbuje
utworzyć rozwiązanie do rozmów wideo tego typu. Upewnij się, że te funkcje wykonują tylko minimalną ilość pracy niezbędną do utworzenia rozmowy wideo. Zbyt duża ilość pracy w tych funkcjach może spowodować, że dodatek będzie działać wolno.
Używaj odpowiednich pól ConferenceData do danych rozmowy wideo
Podczas tworzenia
ConferenceData
obiektów możesz wypełnić je szczegółami dotyczącymi rozmowy wideo (kody dostępu,
numery telefonów, kody PIN, identyfikatory URI itp.). Upewnij się, że używasz odpowiedniego
EntryPoint pola dla
tych informacji. Nie umieszczaj tych szczegółów w polu notatek ConferenceData.
Nie dołączaj szczegółów rozmowy wideo do wydarzenia w Kalendarzu
Dodatek nie musi dodawać informacji o utworzonych rozmowach wideo innych firm do opisu wydarzenia w Kalendarzu. Kalendarz robi to automatycznie, gdy jest to konieczne.