Wenn Sie diese Anleitungen zum Add-on-Design befolgen, können Sie die Nutzerfreundlichkeit insgesamt verbessern.
Allgemeine Best Practices
Wir empfehlen Ihnen, die folgenden Best Practices für alle Add-ons zu verwenden, die Sie entwickeln.
Add-on-Inhaberschaft vor dem Starten ermitteln
Add-ons werden durch Apps Script-Projekte definiert, die einem bestimmten Konto gehören oder in einer geteilten Ablage gespeichert sein müssen. Bevor Sie ein Add-on programmieren, müssen Sie festlegen, welches Konto das Projekt und welches Konto den Publisher des Projekts enthält. Legen Sie außerdem fest, welche Konten als Mitbearbeiter fungieren sollen, und sorgen Sie dafür, dass diese Konten Zugriff auf das Skriptprojekt und das zugehörige Google Cloud-Projekt haben.
Google Workspace erweitern, nicht replizieren
Add-ons sollen die Google Workspace-Anwendungen, die sie erweitern, um neue Funktionen ergänzen oder komplexe Aufgaben automatisieren. Add-ons, die lediglich Funktionen replizieren, die bereits in der Anwendung vorhanden sind, oder die keine wesentlichen Verbesserungen an einem Workflow vornehmen, bestehen die Add-on-Überprüfung für die Veröffentlichung wahrscheinlich nicht.
Bereiche eingrenzen
Wenn Sie Bereiche explizit definieren, wählen Sie immer die restriktivsten Bereiche aus, die möglich sind. Ihr Add-on sollte beispielsweise nicht mit dem Bereich https://www.googleapis.com/auth/calendar vollständigen Zugriff auf den Kalender des Nutzers anfordern, wenn nur Lesezugriff erforderlich ist. Verwenden Sie für den schreibgeschützten Zugriff den Bereich https://www.googleapis.com/auth/calendar.readonly.
Nicht zu sehr auf Bibliotheken verlassen
Die Verwendung von Apps Script-Bibliotheken kann dazu führen, dass Ihr Add-on langsamer ausgeführt wird, als wenn der gesamte Apps Script-Code in einem einzelnen Skriptprojekt enthalten wäre. Apps Script-Bibliotheken funktionieren zwar in Add-ons, aber ihre Verwendung kann die Leistung beeinträchtigen. Vermeiden Sie es, unnötige Bibliotheken in Ihr Projekt aufzunehmen, und überlegen Sie, wie Sie die Abhängigkeit Ihres Add-ons von ihnen verringern 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 ohne diese Latenz verwenden.
Best Practices für Google Workspace-Add‑ons
Die folgenden Best Practices gelten nur für Google Workspace-Add-ons und die Verwendung des Card-Dienstes.
Nur wenige Karten verwenden
Wenn das Add-on zu viele Karten verwendet, wird die Navigationskonfiguration komplex und schwer zu verwalten.
Erstellen Sie nicht mehr Karten als nötig.
Funktionen zum Erstellen von Widgets verwenden
Wenn Sie Code schreiben, der ein Card oder andere komplexe UI-Objekte erstellt, 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 Benutzeroberfläche aktualisiert werden muss. Denken Sie daran, build() aufzurufen, nachdem Sie die Builder-Klassen im Kartendienst verwendet haben.
Karten einfach halten
Wenn eine Karte zu viele Widgets enthält, kann sie zu viel Platz auf dem Bildschirm einnehmen und weniger nützlich sein. Wenn große Kartenabschnitte als minimierbare UI-Elemente gerendert werden, werden Informationen für den Nutzer ausgeblendet. Versuchen Sie, Ihr Add-on zu optimieren und genau das bereitzustellen, was der Nutzer benötigt.
Fehlerkarten verwenden
Karten für Fehlerbedingungen erstellen Wenn in Ihrem Add-on ein Fehler auftritt, sollte eine Karte mit den Fehlerinformationen und, falls möglich, einer Anleitung zur Behebung angezeigt werden. Wenn Ihr Add-on beispielsweise keine Verbindung zu einem Nicht-Google-Dienst herstellen konnte, weil die Autorisierung fehlgeschlagen ist, zeigen Sie eine Karte mit dieser Information an und bitten Sie den Nutzer, die verwendeten Kontoinformationen zu bestätigen.
Tests und Testnachrichten schreiben
Sie sollten alle Add-ons, die Sie erstellen, gründlich testen. Erstellen Sie Testfunktionen, mit denen Karten und Widgets mit Testdaten erstellt werden. Prüfen Sie dann, ob die Objekte wie erwartet erstellt werden.
Wenn Sie Aktions-Callback-Funktionen verwenden, müssen Sie in der Regel ein Antwortobjekt erstellen. Mit Anweisungen wie den folgenden können Sie prüfen, ob die Antworten richtig erstellt werden:
Logger.log(response.printJson());
Sie können Testfunktionen, die Sie erstellen, direkt über das Menü Ausführen im Apps Script-Editor ausführen. Wenn Sie ein funktionierendes Add-on haben, installieren Sie die unveröffentlichte Version, um es zu testen.
Verwenden Sie Testdaten, die für jede Hostanwendung geeignet sind, die durch das Add-on erweitert wird. Wenn das Add-on beispielsweise Gmail erweitert, benötigen Sie wahrscheinlich einige Test-E‑Mails und deren Nachrichten-IDs, damit Sie sicherstellen können, dass das Add-on bei unterschiedlichen Nachrichteninhalten wie erwartet funktioniert. Sie können die Nachrichten-ID für eine bestimmte Nachricht abrufen, indem Sie Nachrichten mit der Gmail API-Methode users.messages.list auflisten oder den Gmail-Dienst von Apps Script verwenden.
Best Practices für Videokonferenzen in Google Kalender
Wenn Ihr Add-on Videokonferenzoptionen von Drittanbietern in Google Kalender einbindet, sollten Sie die folgenden zusätzlichen Best Practices beachten:
onCreateFunction-Leuchte in Betrieb nehmen
Jeder onCreateFunction, den Sie in Ihrem Manifest definieren, wird synchron aufgerufen, wenn ein Nutzer versucht, eine Konferenzlösung dieses Typs zu erstellen. Achten Sie darauf, dass diese Funktionen nur die für die Erstellung der Videokonferenz erforderlichen Schritte ausführen. Wenn Sie zu viel in diesen Funktionen ausführen, kann dies zu einer langsamen Nutzererfahrung für Ihr Add-on führen.
Geeignete ConferenceData-Felder für Konferenzdaten verwenden
Wenn Sie ConferenceData-Objekte erstellen, können Sie sie mit Details zur Videokonferenz füllen (Zugriffscodes, Telefonnummern, PINs, URIs usw.). Verwenden Sie für diese Informationen das entsprechende Feld EntryPoint. Geben Sie diese Informationen nicht im Notizenfeld ConferenceData an.
Dem Kalendertermin keine Videokonferenzdetails hinzufügen
Ihr Add-on muss der Beschreibung des Kalendertermins keine Informationen zu erstellten Drittanbieterkonferenzen hinzufügen. Google Kalender erledigt das bei Bedarf automatisch.