Aby zadbać o komfort użytkowników, postępuj zgodnie z tymi przewodnikami dotyczącymi projektowania dodatków.
Ogólne sprawdzone metody
Zachęcamy do stosowania tych sprawdzonych metod w przypadku wszystkich tworzonych dodatków.
Przed rozpoczęciem określania własności dodatku
dodatki są definiowane przez projekty Apps Script, które muszą należeć do określonego konta lub zostać umieszczone na dysku współdzielonym. Przed zakodowaniem dodatku określ, które konto ma być właścicielem projektu, a które ma działać jako wydawca. Określ też, które konta mają działać jako współpracownicy, i upewnij się, że mają one dostęp do projektu skryptu oraz powiązanego z nim projektu Cloud Platform.
Rozszerzanie możliwości Google Workspace bez replikacji
dodatki do nowych aplikacji Google Workspace, które rozszerzają, lub działające w sposób zautomatyzowany.
Ogranicz zakresy
Podczas jednoznacznego definiowania zakresów zawsze wybieraj najmniej możliwy zakres. Nie wymagaj na przykład pełnego dostępu do kalendarza użytkownika w zakresie https://www.googleapis.com/auth/calendar, jeśli potrzebuje on tylko uprawnień do odczytu. Aby uzyskać dostęp tylko do odczytu, użyj zakresu https://www.googleapis.com/auth/calendar.readonly.
Unikaj zbyt polegania na bibliotekach
Korzystanie z bibliotek Apps Script może spowodować, że dodatek będzie wolniej działać, niż gdyby cały kod Apps Script znajdował się w jednym projekcie skryptu. Chociaż biblioteki Apps Script działają w dodatkach, możesz zauważyć obniżenie ich wydajności, jeśli z nich korzystasz. Unikaj zbędnych bibliotek w projekcie i rozważ, jak możesz nie polegać na nich.
Opisane wyżej opóźnienie ma zastosowanie tylko do projektów Apps Script używanych jako biblioteki po stronie serwera. Możesz używać bibliotek JavaScript po stronie klienta, takich jak jQuery, w dowolny sposób bez opóźnień.
Sprawdzone metody dotyczące dodatku do Google Workspace
Poniższe sprawdzone metody mają zastosowanie tylko do Dodatków do Google Workspace oraz do korzystania z usługi kart.
Użyj tylko kilku kart
Jeśli dodatek używa zbyt wielu kart, konfiguracja nawigacji staje się skomplikowana i trudna w zarządzaniu.
Unikaj impulsu, aby tworzyć 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, rozważ umieszczenie tego kodu w osobnej funkcji.
Ta funkcja tworzenia powinna tylko utworzyć obiekt i go zwrócić. Dzięki temu możesz szybko wygenerować ten obiekt za każdym razem, gdy trzeba będzie odświeżyć interfejs. Pamiętaj, aby po wywołaniu klas kreatora w usłudze karty wywołać build().
Proste karty
Jeśli karta zawiera zbyt wiele widżetów, może zapełniać za dużo ekranu i stać się mniej przydatna. Duże sekcje kart są renderowane jako zwijane elementy interfejsu, ale użytkownicy nie mają dostępu do takich informacji. Postaraj się uprościć dodatek i przedstawić dokładnie to, czego potrzebuje użytkownik.
Używanie kart błędów
Utwórz karty dla warunków błędu. Jeśli dodatek generuje błąd, powinna wyświetlić kartę z informacjami o błędzie i instrukcjami, jak go naprawić. Jeśli na przykład Twój dodatek nie może połączyć się z usługą niezwiązaną z Google, ponieważ autoryzacja nie powiodła się, wyświetl odpowiednią kartę i poproś użytkownika o sprawdzenie używanych danych konta.
Pisanie testów i tworzenie wiadomości testowych
Dokładnie przetestuj wszystkie utworzone przez siebie dodatki. Utwórz funkcje testowe, które tworzą karty i widżety na podstawie danych testowych, a następnie sprawdź, czy obiekty są tworzone zgodnie z oczekiwaniami.
Gdy korzystasz z funkcji wywołania zwrotnego działania, zazwyczaj musisz utworzyć obiekt odpowiedzi. Aby sprawdzić, czy odpowiedzi są poprawnie tworzone, możesz użyć takich instrukcji jak poniżej:
Logger.log(response.printJson());
Uruchamiaj funkcje testowe utworzone bezpośrednio w edytorze Apps Script, korzystając z menu Uruchom. Jeśli masz działający dodatek, zainstaluj nieopublikowaną wersję, żeby go przetestować.
Użyj danych testowych odpowiednich dla każdej aplikacji hosta, której dotyczy dodatek. Jeśli na przykład dodatek rozszerza Gmaila, potrzebujesz kilku testowych adresów e-mail i ich identyfikatorów, aby upewnić się, że dodatek działa zgodnie z oczekiwaniami, gdy jest wyświetlana inna treść wiadomości. Identyfikator wiadomości możesz uzyskać, wymieniając wiadomości za pomocą metody Gmail API Users.messages.list lub korzystając z usługi Gmail Apps Script.
Sprawdzone metody prowadzenia rozmów wideo w Kalendarzu
Jeśli Twój dodatek integruje z Kalendarzem Google opcje rozmów wideo innych firm, zastosuj te dodatkowe sprawdzone metody:
Pilnuj, by urządzenie onCreateFunction świeciło
Każdy element onCreateFunction, który zdefiniujesz w pliku manifestu, jest wywoływany synchronicznie, gdy użytkownik próbuje utworzyć rozwiązanie konferencyjne tego typu. Upewnij się, że służą one tylko do minimum niezbędnej do utworzenia rozmowy wideo. Zbyt duża liczba funkcji może spowolnić działanie dodatku.
Korzystanie z odpowiednich pól ConferenceData w przypadku danych rozmów wideo
Podczas tworzenia obiektów ConferenceData możesz dodać do nich szczegóły rozmowy wideo (kody dostępu, numery telefonów, pinezki, identyfikatory URI itp.). Sprawdź, czy w przypadku tej informacji używasz odpowiedniego pola EntryPoint. Nie umieszczaj tych informacji w polu ConferenceData notatek.
Nie dodawaj szczegółów rozmowy wideo do wydarzenia w Kalendarzu Google
Twój dodatek nie musi dodawać w opisie wydarzenia w Kalendarzu Google informacji o utworzonych konferencjach zewnętrznych. Kalendarz Google robi to automatycznie, gdy jest to konieczne.