Best Practices

Mit diesen Anleitungen für das Design von Add-ons können Sie die Nutzerfreundlichkeit insgesamt verbessern.

Allgemeine Best Practices

Wir empfehlen Ihnen, die folgenden Best Practices für alle von Ihnen entwickelten Add-ons zu verwenden.

Inhaber des Add-ons vor Beginn ermitteln

Add-ons werden in Apps Script-Projekten definiert, die einem bestimmten Konto gehören oder in einer freigegebenen Google Drive-Ablage abgelegt sein 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 Script-Projekt und das zugehörige Google Cloud-Projekt 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 die einen Workflow nicht wesentlich verbessern, bestehen die Add-on-Überprüfung für die Veröffentlichung wahrscheinlich nicht.

Begrenzen Sie den Geltungsbereich.

Wenn Sie Ihre Bereiche explizit definieren, wählen Sie immer die am wenigsten permissiven Bereiche aus. Fordern Sie beispielsweise nicht den uneingeschränkten 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, die Leistung kann jedoch sinken, 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 den HTML- und JavaScript-Code, der die Seitenleisten und Dialogfelder des Add-ons definiert, in separaten Scriptdateien platzieren.

 Umfassend in verschiedenen Autorisierungsmodi testen

Testen Sie beim Testen Ihres Add-ons Konfigurationen mit verschiedenen Dateien und verschiedenen Autorisierungsstatus.