Aby zwiększyć wygodę użytkowników, postępuj zgodnie z tymi przewodnikami na temat tworzenia dodatków.
Ogólne sprawdzone metody
Zachęcamy do stosowania sprawdzonych metod w przypadku wszystkich tworzonych dodatków.
Przed rozpoczęciem określ prawo własności do dodatku
Dodatki są definiowane przez projekty Apps Script, które muszą należeć do określonego konta lub w innym przypadku umieszczone na dysku współdzielonym. Przed zakodowaniem dodatku ustal, które konto powinno być właścicielem projektu i które konto będzie jego wydawcą. Określ też, które konta mają pełnić rolę współpracowników, i sprawdź, czy konta te mają dostęp do projektu skryptu i powiązanego z nim projektu Cloud Platform.
Rozszerz zakres Google Workspace, nie powielaj go
Dodatki zapewniają nowe możliwości rozszerzonym aplikacjom Google Workspace lub automatyzują złożone zadania. Dodatki, które tylko powielają funkcje już zawarte w aplikacji lub nie wprowadzają znacznych ulepszeń w przepływie pracy, prawdopodobnie nie przejdą weryfikacji dodatków do publikacji.
Zawęź zakresy
Podczas jawnego definiowania zakresów zawsze wybieraj zestaw tych, które są najmniej restrykcyjne. Na przykład nie używaj prośby dodatku o pełny dostęp do kalendarza użytkownika z zakresem https://www.googleapis.com/auth/calendar, jeśli wymaga on tylko uprawnień do odczytu. Aby uzyskać dostęp tylko do odczytu, użyj zakresu https://www.googleapis.com/auth/calendar.readonly.
Staraj się nie polegać za bardzo na bibliotekach
Korzystanie z bibliotek Apps Script może spowodować, że dodatek będzie działać wolniej niż gdyby cały kod Apps Script zawarty w jednym projekcie skryptu. Chociaż biblioteki Apps Script działają w dodatkach, ich używanie może spowodować spadek wydajności. Unikaj dodawania do projektu zbędnych bibliotek i zastanów się, w jaki sposób dodatek będzie od nich polegać.
Opisane powyżej opóźnienie 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 takich opóźnień.
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 kart.
Używanie tylko kilku kart
Jeśli dodatek używa zbyt wielu kart, konfiguracja nawigacji staje się złożona i trudna w zarządzaniu.
Nie staraj się utworzyć więcej kart, niż to konieczne.
Korzystanie z funkcji tworzenia widżetów
Gdy piszesz kod, który tworzy Card lub inne złożone obiekty interfejsu, rozważ umieszczenie go w osobnej funkcji.
Ta funkcja tworzenia powinna po prostu skompilować i zwrócić go. Dzięki temu możesz szybko ponownie wygenerować ten obiekt przy każdej zmianie interfejsu użytkownika. Pamiętaj, aby wywołać build() po użyciu klas kreatora w usłudze karty.
Proste karty
Jeśli dana karta ma zbyt wiele widżetów, może zająć zbyt dużo ekranu i być mniej przydatna. Duże sekcje kart renderują się jako zwijane elementy interfejsu, ale powodują ukrycie informacji przed użytkownikiem. Postaraj się uprościć dodatek i zapewniać użytkownikowi dokładnie to, czego potrzebuje, a nie więcej.
Korzystanie z kart błędów
Utwórz karty dla warunków błędów. Jeśli dodatek generuje błąd, powinien pojawić się karta z informacjami o błędzie i instrukcjami, jak go naprawić, jeśli jest to możliwe. Jeśli na przykład dodatek nie może połączyć się z usługą firmy innej niż Google, ponieważ autoryzacja nie powiodła się, wyświetl kartę z informacją o tym i poproś użytkownika o sprawdzenie informacji o używanym koncie.
Pisanie testów i wiadomości testowych
Musisz dokładnie przetestować wszystkie utworzone dodatki. Utwórz funkcje testowe, które tworzą karty i widżety na podstawie danych testowych, a następnie sprawdź, czy obiekty są utworzone zgodnie z oczekiwaniami.
Gdy używasz funkcji wywołania zwrotnego działania, zazwyczaj trzeba utworzyć obiekt odpowiedzi. Za pomocą poniższych stwierdzeń możesz sprawdzić, czy odpowiedzi zostały poprawnie skonstruowane:
Logger.log(response.printJson());
Możesz uruchamiać funkcje testowe utworzone bezpośrednio w edytorze Apps Script przy użyciu menu Uruchom. Jeśli masz działający dodatek, zainstaluj nieopublikowaną wersję, aby móc ją przetestować.
Użyj danych testowych odpowiednich dla każdej aplikacji hosta rozszerzanej przez dodatek. Jeśli na przykład dodatek rozszerza Gmaila, prawdopodobnie potrzebujesz kilku e-maili testowych i ich identyfikatorów, aby mieć pewność, że dodatek będzie działać zgodnie z oczekiwaniami, gdy pojawi się inna treść wiadomości. Aby uzyskać identyfikator danej wiadomości, możesz wyświetlić listę wiadomości za pomocą metody Users.messages.list w interfejsie Gmail API lub za pomocą usługi Gmail Apps Script.
Rozmowy wideo w Kalendarzu – sprawdzone metody
Jeśli Twój dodatek integruje z Kalendarzem Google opcje rozmów wideo innych firm, postępuj zgodnie z tymi dodatkowymi sprawdzonymi metodami:
Utrzymuj oświetlenie onCreateFunction
Każdy element onCreateFunction zdefiniowany w pliku manifestu jest nazywany synchronicznie, gdy użytkownik próbuje utworzyć rozwiązanie do obsługi konferencji tego typu. Te funkcje powinny wykonywać tylko tyle pracy, ile jest to konieczne do utworzenia konferencji. Wykonanie zbyt wielu zadań z tych funkcji może spowolnić korzystanie z dodatku.
Użyj odpowiednich pól ConferenceData w przypadku danych rozmowy wideo
Gdy tworzysz obiekty ConferenceData, możesz zapełniać je szczegółami rozmowy (kodami dostępu, numerami telefonów, kodami PIN, identyfikatorem URI itp.). Pamiętaj, aby użyć odpowiedniego pola EntryPoint. Nie umieszczaj ich w polu ConferenceData uwag.
Nie dodawaj szczegółów rozmowy wideo do wydarzenia w Kalendarzu Google.
Twój dodatek nie musi dodawać do opisu wydarzenia w Kalendarzu Google informacji o utworzonych konferencjach innych firm. W razie potrzeby Kalendarz Google robi to automatycznie.