Best Practices

Verbessern Sie die Nutzerfreundlichkeit Ihrer Add-ons, indem Sie diese Leitfäden zum Add-on-Design befolgen.

Allgemeine Best Practices

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

Add-on-Inhaberschaft vor Beginn festlegen

Add-ons werden durch Apps Script-Projekte definiert, die einem bestimmten Konto gehören oder in einer geteilten Ablage gespeichert sein müssen. Legen Sie vor dem Programmieren eines Add-ons fest, welches Konto Inhaber des Projekts sein soll und welches Konto als Herausgeber fungiert. 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-Projekthaben.

Hinweis: Die Inhaberschaft von Add-ons muss geplant werden. Wenn der Add-on-Inhaber Ihr Unternehmen verlässt, müssen Sie dafür sorgen, dass die Inhaberschaft übertragen wird. Andernfalls können Sie Ihr Add-on möglicherweise nicht mehr aktualisieren und verwalten. Aus diesem Grund ist es möglicherweise am besten, ein Organisationskonto zu erstellen, das speziell für die Inhaberschaft und Veröffentlichung der Add-ons Ihrer Organisation vorgesehen ist. Sie können auch eine geteilte Ablage als Inhaber des Skriptprojekts verwenden, aber ein bestimmtes Konto muss als Herausgeber des Add-ons fungieren.

Google Workspace erweitern, nicht replizieren

Add-ons sollen den Google Workspace-Anwendungen, die sie erweitern, neue Funktionen bieten 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 einschränken

Wenn Sie Ihre Bereiche explizit definieren, wählen Sie immer die am wenigsten permissive Gruppe von Bereichen aus. Beispielsweise sollte Ihr Add-on mit dem Bereich https://www.googleapis.com/auth/calendar keinen vollständigen Zugriff auf den Kalender des Nutzers anfordern, 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 verlassen

Wenn Sie Apps Script-Bibliotheken verwenden, kann es sein, dass Ihr Add-on langsamer ausgeführt wird, als wenn der gesamte Apps Script-Code in einem einzigen Skriptprojekt enthalten wäre. Apps Script-Bibliotheken funktionieren zwar in Add-ons, aber ihre Verwendung kann zu Leistungseinbußen führen. 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 Editor-Add-ons

Die folgenden Best Practices gelten nur für Editor-Add-ons.

HTML-Code für die Benutzeroberfläche und clientseitiges JavaScript in eigenen Skriptdateien platzieren

Sie können in einem Apps Script-Projekt mehrere Skriptdateien erstellen. Es ist einfacher, ein komplexes Add-on zu verwalten, wenn Sie den HTML- und JavaScript-Code, der die Add-on-Seitenleisten und -Dialogfelder definiert, in eigenen Skriptdateien platzieren.

Gründlich in verschiedenen Autorisierungsmodi testen

Testen Sie Ihr Add-on mit verschiedenen Konfigurationen, die unterschiedliche Dateien und unterschiedliche Autorisierungs status haben.