Mit diesen Anleitungen zum Design von Add-ons können Sie die Nutzerfreundlichkeit Ihrer Add-ons verbessern.
Allgemeine Best Practices
Wir empfehlen Ihnen, die folgenden Best Practices für alle von Ihnen entwickelten Add-ons zu beachten.
Inhaber des Add-ons vor Beginn ermitteln
Add-ons werden über Apps Script-Projekte definiert, deren Inhaber ein bestimmtes Konto sein muss oder die sich in einer freigegebenen Ablage befinden müssen. Bevor Sie ein Add-on programmieren, müssen Sie festlegen, welchem Konto das Projekt zugewiesen werden soll und welches Konto als Publisher fungiert. Legen Sie außerdem fest, welche Konten als Mitbearbeiter fungieren sollen, und achten Sie darauf, dass diese Konten Zugriff auf das Scriptprojekt und das zugehörige Cloud-Plattformprojekt haben.
Google Workspace erweitern, nicht replizieren
Add-ons sollen den erweiterten Google Workspace-Anwendungen neue Funktionen bieten oder komplexe Aufgaben automatisieren. Add-ons, die lediglich Funktionen der Anwendung duplizieren oder keine wesentlichen Verbesserungen an einem Workflow vornehmen, bestehen die Add-on-Prüfung für die Veröffentlichung wahrscheinlich nicht.
Begrenzen Sie den Geltungsbereich.
Wählen Sie beim expliziten Definieren von Bereichen immer den möglichst restriktiven Bereich aus. Fordern Sie beispielsweise nicht den vollständigen Zugriff auf den Kalender des Nutzers mit dem Bereich https://www.googleapis.com/auth/calendar an, wenn nur Lesezugriff erforderlich ist. Verwenden Sie für den Lesezugriff den Bereich https://www.googleapis.com/auth/calendar.readonly.
Nicht zu stark auf Bibliotheken angewiesen sein
Wenn Sie Apps Script-Bibliotheken verwenden, kann Ihr Add-on langsamer laufen als wenn der gesamte Apps Script-Code in einem einzigen Script-Projekt enthalten wäre. Apps Script-Bibliotheken funktionieren zwar in Add-ons, es kann jedoch zu Leistungseinbußen kommen, wenn Sie sie verwenden. Fügen Sie Ihrem Projekt keine unnötigen Bibliotheken hinzu und überlegen Sie, wie Sie die Abhängigkeit Ihres Add-ons von ihnen 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 Editor-Add-ons
Die folgenden Best Practices gelten nur für das Editor-Add-on.
HTML-Code für die Benutzeroberfläche und clientseitiges JavaScript in eigenen Scriptdateien platzieren
Sie können in einem Apps Script-Projekt mehrere Scriptdateien erstellen. Komplexe Add-ons lassen sich leichter verwalten, wenn Sie das HTML und JavaScript, das die Seitenleisten und Dialogfelder des Add-ons definiert, in dafür vorgesehene Scriptdateien einfügen.
Gründlich in verschiedenen Autorisierungsmodi testen
Testen Sie beim Testen Ihres Add-ons Konfigurationen mit verschiedenen Dateien und verschiedenen Autorisierungsstatus.