Popraw ogólne wrażenia użytkowników, korzystając z tych przewodników dotyczących projektowania dodatków.
Ogólne sprawdzone metody
Zachęcamy do stosowania tych sprawdzonych metod w przypadku wszystkich opracowywanych dodatków.
Przed rozpoczęciem ustal, kto jest właścicielem dodatku
Dodatki są definiowane przez projekty Apps Script, które muszą należeć do określonego konta lub znajdować się na dysku współdzielonym. Przed napisaniem kodu dodatku określ, które konto powinno być właścicielem projektu, a które kontem wydawcy. 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 nim projektu Google Cloud.
Rozszerzaj Google Workspace, nie duplikuj go
Dodatki mają na celu rozszerzanie możliwości aplikacji Google Workspace, do których są dodawane, lub automatyzowanie złożonych zadań. Dodatki, które jedynie powielają funkcje już dostępne w aplikacji lub nie wprowadzają znaczących ulepszeń w procesie pracy, prawdopodobnie nie przejdą weryfikacji i nie zostaną opublikowane.
Ogranicz zakresy
Podczas wyraźnego określania zakresów zawsze wybieraj najmniej restrykcyjny zestaw zakresów. Na przykład nie przyznawaj dodatkowi pełnego dostępu do Kalendarza użytkownika za pomocą zakresu https://www.googleapis.com/auth/calendar, jeśli potrzebuje on tylko dostępu 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ż w przypadku, gdyby cały kod Apps Script znajdował się w jednym projekcie skryptu. Biblioteki Apps Script działają w dodatkach, ale ich używanie może obniżyć wydajność. 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óźnienia.
Sprawdzone metody dotyczące dodatków do Google Workspace
Poniższe 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ę skomplikowana i trudna w zarządzaniu.
Unikaj tworzenia większej liczby 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, rozważ umieszczenie tego kodu we własnej funkcji. Ta funkcja tworzenia powinna tylko utworzyć obiekt i go zwrócić. Dzięki temu możesz szybko ponownie wygenerować ten obiekt, gdy interfejs musi zostać odświeżony. Pamiętaj, aby po użyciu klas konstruktora w usłudze Card wywołać funkcję build().
Proste karty
Jeśli dana karta zawiera zbyt wiele widżetów, może zajmować zbyt dużą część ekranu i być mniej przydatna. Duże sekcje kart są renderowane jako zwijane elementy interfejsu, co ukrywa informacje przed użytkownikiem. Staraj się uprościć dodatek i zapewnić użytkownikowi dokładnie to, czego potrzebuje, i nic więcej.
Korzystanie z kart błędów
Tworzenie kart dla warunków błędu. 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 się nie powiodła, wyświetl kartę z informacją o tym i poproś użytkownika o sprawdzenie używanych informacji o koncie.
Pisanie testów i wiadomości testowych
Wszystkie utworzone dodatki należy dokładnie przetestować. Twórz funkcje testowe, które tworzą karty i widżety przy użyciu danych testowych, a następnie sprawdzaj, czy obiekty są tworzone zgodnie z oczekiwaniami.
Gdy używasz funkcji wywołania zwrotnego działania, zwykle musisz utworzyć obiekt odpowiedzi. Aby sprawdzić, czy odpowiedzi są prawidłowo konstruowane, możesz użyć takich stwierdzeń:
Logger.log(response.printJson());
Uruchamiaj utworzone funkcje testowe bezpośrednio w edytorze Apps Script za pomocą menu Uruchom. Gdy masz już działający dodatek, zainstaluj nieopublikowaną wersję, aby móc ją 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, aby upewnić się, ż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 Gmail API lub korzystając z usługi Gmail w Apps Script.users.messages.list
Sprawdzone metody dotyczące konferencji w Kalendarzu
Jeśli dodatek integruje z Kalendarzem Google opcje rozmów wideo w kalendarzu innej firmy, postępuj zgodnie z tymi dodatkowymi sprawdzonymi metodami:
Zadbaj o lekkość onCreateFunction
Każda onCreateFunction zdefiniowana w pliku manifestu jest wywoływana synchronicznie, gdy użytkownik próbuje utworzyć rozwiązanie konferencyjne tego typu. Upewnij się, że te funkcje wykonują tylko minimalną niezbędną pracę, aby utworzyć konferencję. Zbyt duża liczba działań w tych funkcjach może spowolnić działanie dodatku.
Używaj odpowiednich pól ConferenceData do danych konferencji
Podczas tworzenia obiektówConferenceData możesz wypełniać je szczegółami konferencji (kodami dostępu, numerami telefonów, kodami PIN, adresami URI itp.). Pamiętaj, aby użyć odpowiedniego pola EntryPoint. Nie umieszczaj tych informacji w ConferenceData polu notatek.
Nie dołączaj szczegółów rozmowy wideo do wydarzenia w Kalendarzu
Dodatek nie musi dodawać informacji o utworzonych konferencjach innych firm do opisu wydarzenia w Kalendarzu. Kalendarz robi to automatycznie w razie potrzeby.