Wenn Sie diese Leitfäden für das Design von Add-ons befolgen, können Sie die Nutzerfreundlichkeit insgesamt verbessern.
Allgemeine Best Practices
Wir empfehlen Ihnen, für alle von Ihnen entwickelten Add-ons die folgenden Best Practices zu befolgen.
Eigentumsrechte für Add-ons vor Beginn bestimmen
Add-ons werden durch Apps Script-Projekte definiert. Diese müssen einem bestimmten Konto gehören oder sich in einer geteilten Ablage befinden. Bestimmen Sie vor dem Codieren eines Add-ons, welchem Konto das Projekt gehören soll und welches Konto als Publisher fungiert. Legen Sie außerdem fest, welche Konten als Mitbearbeiter dienen sollen. Sorgen Sie außerdem dafür, dass diese Konten Zugriff auf das Skriptprojekt und das zugehörige Cloud Platform-Projekt haben.
Google Workspace erweitern, nicht replizieren
Add-ons sollen den von ihnen erweiterten Google Workspace-Anwendungen neue Funktionen zur Verfügung stellen oder auch komplexe Aufgaben automatisieren. Add-ons, die lediglich Funktionen replizieren, die bereits in der Anwendung vorhanden sind, oder solche, die keine wesentlichen Verbesserungen an einem Workflow ermöglichen, werden wahrscheinlich nicht zur Veröffentlichung Add-on-Prüfungen bestehen.
Bereiche begrenzen
Wenn Sie Bereiche explizit definieren, wählen Sie immer die Gruppe von Bereichen mit den geringsten Berechtigungen aus. Beispielsweise haben Sie für Ihre Add-on-Anfrage keinen uneingeschränkten Zugriff auf den Kalender des Nutzers mit dem Bereich https://www.googleapis.com/auth/calendar, wenn sie nur Lesezugriff benötigt. Verwenden Sie für den Lesezugriff den Bereich https://www.googleapis.com/auth/calendar.readonly.
Zu viele Bibliotheken nutzen
Wenn Sie Apps Script-Bibliotheken verwenden, wird Ihr Add-on möglicherweise langsamer ausgeführt als der gesamte Apps Script-Code in einem einzigen Skriptprojekt. Obwohl Apps Script-Bibliotheken in Add-ons funktionieren, kann es zu Leistungseinbußen kommen, wenn Sie sie verwenden. Vermeiden Sie unnötige Bibliotheken in Ihr Projekt und überlegen Sie, wie Sie die Abhängigkeit Ihres Add-ons reduzieren können.
Die oben beschriebene Latenz gilt nur für Apps Script-Projekte, die als serverseitige Bibliotheken verwendet werden. Sie können clientseitige JavaScript-Bibliotheken wie jQuery frei verwenden, ohne dass diese Latenz auftritt.
Best Practices für Google Workspace-Add-ons
Die folgenden Best Practices gelten nur für Google Workspace-Add-ons und die Verwendung des Kartendienstes.
Nur wenige Karten verwenden
Wenn das Add-on zu viele Karten verwendet, wird die Navigationskonfiguration komplex und schwer zu verwalten.
Vermeiden Sie es, mehr Karten als nötig zu erstellen.
Funktionen zur Widgeterstellung verwenden
Wenn Sie Code schreiben, mit dem Card oder andere komplexe UI-Objekte erstellt werden, sollten Sie diesen Code in eine eigene Funktion einfügen.
Diese Erstellungsfunktion sollte nur das Objekt erstellen und zurückgeben. So können Sie das Objekt schnell neu generieren, wenn die UI aktualisiert werden muss. Vergiss nicht, build() aufzurufen, nachdem du die Builder-Klassen im Kartendienst verwendet hast.
Karten einfach halten
Wenn eine bestimmte Karte zu viele Widgets enthält, füllt sie möglicherweise zu viel Fläche des Bildschirms aus und wird weniger nützlich. Während große Kartenabschnitte als minimierbare UI-Elemente gerendert werden, sind dadurch Informationen für den Nutzer verborgen. Optimieren Sie das Add-on und bieten Sie Nutzern genau das, was sie brauchen.
Fehlerkarten verwenden
Karten für Fehlerbedingungen erstellen Wenn Ihr Add-on einen Fehler verursacht, sollte eine Karte mit den Fehlerinformationen und einer Anleitung zur Fehlerbehebung angezeigt werden. Wenn Ihr Add-on beispielsweise aufgrund eines Autorisierungsfehlers keine Verbindung zu einem Nicht-Google-Dienst herstellen konnte, zeigen Sie eine Karte an, auf der dies angegeben ist, und bitten Sie den Nutzer, die verwendeten Kontoinformationen zu überprüfen.
Tests und Testnachrichten schreiben
Sie sollten alle erstellten Add-ons gründlich testen. Erstellen Sie Testfunktionen, die mithilfe von Testdaten Karten und Widgets erstellen, und prüfen Sie dann, ob die Objekte wie erwartet erstellt werden.
Wenn Sie Aktions-Callback-Funktionen verwenden, müssen Sie normalerweise ein Antwortobjekt erstellen. Sie können Anweisungen wie die folgenden verwenden, um zu überprüfen, ob die Antworten korrekt aufgebaut sind:
Logger.log(response.printJson());
Über das Menü Ausführen können Sie Testfunktionen ausführen, die Sie direkt im Apps Script-Editor erstellt haben. Wenn das Add-on funktionsfähig ist, installieren Sie die unveröffentlichte Version, damit Sie es testen können.
Verwenden Sie für jede durch das Add-on erweiterte Hostanwendung geeignete Testdaten. Wenn das Add-on beispielsweise Gmail erweitert, benötigen Sie wahrscheinlich einige Test-E-Mails und deren Nachrichten-IDs, damit das Add-on bei unterschiedlichem Nachrichteninhalt wie erwartet funktioniert. Sie können die Nachrichten-ID einer bestimmten Nachricht abrufen, indem Sie Nachrichten mit der Methode Gmail API Users.messages.list auflisten oder den Gmail-Dienst von Apps Script verwenden.
Best Practices für Videokonferenzen in Google Kalender
Wenn Ihr Add-on Drittanbieter-Kalenderkonferenzoptionen in Google Kalender integriert, befolgen Sie diese zusätzlichen Best Practices:
onCreateFunction-Lampe behalten
Jedes onCreateFunction, das Sie im Manifest definieren, wird synchron aufgerufen, wenn ein Nutzer versucht, eine Konferenzlösung dieses Typs zu erstellen. Achten Sie darauf, dass diese Funktionen nur das minimal erforderliche Arbeiten zum Erstellen der Konferenz ausführen. Wenn Sie diese Funktionen zu viel verwenden, kann das Add-on verlangsamt werden.
Geeignete ConferenceData-Felder für Konferenzdaten verwenden
Wenn Sie ConferenceData-Objekte erstellen, können Sie sie mit Details zur Konferenz füllen (Zugriffscodes, Telefonnummern, PINs, URIs usw.). Verwenden Sie für diese Informationen unbedingt das entsprechende Feld EntryPoint. Geben Sie diese Details nicht in das Anmerkungsfeld ConferenceData ein.
Keine Videokonferenzdetails an den Google Kalender-Termin anhängen
Ihr Add-on muss der Beschreibung des Google Kalender-Termins keine Informationen zu erstellten Drittanbieterkonferenzen hinzufügen. Google Kalender erledigt dies bei Bedarf automatisch.