Die Nutzerfreundlichkeit verbessern User Experience haben, indem Sie diese Leitfäden für Add-ons befolgen. Design.
Allgemeine Best Practices
Wir empfehlen Ihnen, die folgenden Best Practices für alle Add-ons zu befolgen, zu entwickeln.
Inhaberschaft des Add-ons vor Beginn bestimmen
Add-ons werden von Apps Script-Projekten definiert, die einem bestimmten Konto oder in einer geteilten Ablage gespeichert. Entscheiden Sie vor dem Programmieren eines Add-ons, zu welchem Konto das Projekt gehören soll. welches Konto als Publisher fungiert. Legen Sie auch fest, welche Konten gehandelt werden sollen. als Mitbearbeiter und stellen Sie sicher, dass diese Konten Zugriff auf das Skript haben. Projekt und die zugehörigen Cloud Platform-Projekt:
Google Workspace erweitern, nicht replizieren
Add-ons sollen dem Nutzer neue Funktionen Erweiterbare Google Workspace-Anwendungen oder um komplexe Aufgaben zu automatisieren. Add-ons nutzen, die lediglich Funktionen replizieren, die bereits im oder solche, die keine wesentlichen Verbesserungen an einem ist es unwahrscheinlich, dass der Workflow die Add-on-Überprüfung für Veröffentlichung.
Umfang eingrenzen
Wenn Sie Ihre Bereiche explizit definieren, gehen Sie so vor:
wählen Sie immer den
kleinstmöglichen Satz von Bereichen. Vermeiden Sie beispielsweise
Ihr Add-on benötigt mit der Funktion
https://www.googleapis.com/auth/calendar Bereich, wenn nur Lesezugriff erforderlich ist
Zugriff haben. Verwenden Sie für Lesezugriff den
https://www.googleapis.com/auth/calendar.readonly Bereich.
Bibliotheken nicht zu sehr nutzen
Die Verwendung von Apps Script-Bibliotheken kann dazu führen, das Add-on langsamer sein soll. wenn der gesamte Apps Script-Code in einem einzigen Skriptprojekt enthalten wäre. Obwohl Apps Script-Bibliotheken in Add-ons funktionieren, kann es zu Leistungseinbußen kommen reduziert, wenn Sie sie verwenden. Vermeiden Sie es, unnötige Bibliotheken und überlegen Sie, wie Sie die Abhängigkeit des Add-ons reduzieren können.
Die oben beschriebene Latenz gilt nur für die verwendeten Apps Script-Projekte als serverseitige Bibliotheken. Sie können clientseitige JavaScript-Bibliotheken wie jQuery verwenden, ohne diese Latenz zu erleben.
Best Practices für Google Workspace-Add-ons
Die folgenden Best Practices gelten nur für Google Workspace-Add-ons und deren Verwendung des Kartendienstes.
Wenige Karten verwenden
Wenn das Add-on zu viele Karten verwendet, wird die Navigationskonfiguration komplex und schwer zu verwalten ist.
Vermeiden Sie den Impuls, mehr Karten als nötig zu erstellen.
Funktionen zum Erstellen von Widgets verwenden
Beim Schreiben von Code, mit dem Card erstellt wird
oder anderen komplexen UI-Objekten verwenden, sollten Sie diesen Code in eine eigene Funktion einbinden.
Diese Erstellungsfunktion sollte nur das Objekt erstellen und zurückgeben. Dadurch können
können Sie dieses Objekt bei jeder Aktualisierung der Benutzeroberfläche schnell neu generieren. Erinnern
zum Aufrufen von build() nach Verwendung der Builder-Klassen in der
Kartendienst.
Karten einfach gestalten
Wenn eine bestimmte Karte zu viele Widgets hat, kann sie zu viel Bildschirm ausfüllen weniger nützlich sind. Während große Kartenabschnitte als minimierbare UI-Elemente gerendert werden, werden die Informationen für den Nutzer ausgeblendet. Optimieren Sie Ihr Add-on und bieten Sie was die Nutzenden brauchen.
Fehlerkarten verwenden
Karten für Fehlerbedingungen erstellen Wenn Ihr Add-on einen Fehler erzeugt, sollte es eine Karte mit den Fehlerinformationen und einer Anleitung zur Fehlerbehebung anzeigen wenn möglich. Wenn Ihr Add-on beispielsweise keine Verbindung zu einem Drittanbieterkonto Dienst nicht verwenden, da die Autorisierung fehlgeschlagen ist, zeigen Sie eine entsprechende Karte an und fragen Sie Der Nutzer muss die verwendeten Kontoinformationen bestätigen.
Tests und Testnachrichten schreiben
Sie sollten alle Add-ons, die Sie erstellen, gründlich testen. Testfunktionen erstellen, die Karten und Widgets mithilfe von Testdaten erstellen und dann überprüfen, ob die Objekte wie erwartet erstellt.
Wenn Sie Aktions-Callback-Funktionen verwenden, müssen Sie normalerweise ein Antwortobjekt erstellen. Sie können Anweisungen wie Gehen Sie so vor, um zu überprüfen, ob die Antworten korrekt aufgebaut werden:
Logger.log(response.printJson());
Von Ihnen erstellte Testfunktionen direkt über Apps Script ausführen Ausführen. Wenn ein brauchbares Add-on funktioniert, müssen Sie die unveröffentlichte Version installieren, damit Sie es testen können.
Verwenden Sie Testdaten, die für jede Hostanwendung, die das Add-on erweitert, geeignet ist. Für Wenn das Add-on beispielsweise Gmail erweitert, brauchen Sie wahrscheinlich ein paar Test-E-Mails, und ihre Nachrichten-IDs, damit das Add-on wie bei unterschiedlichem Nachrichteninhalt zu erwarten ist. Sie können die Nachrichten-ID für eine gegeben werden, indem die Nachrichten mithilfe der Gmail API – Users.messages.list oder mithilfe der Methode Gmail.
Best Practices für Kalenderkonferenzen
Wenn Ihr Add-on Drittanbieter-Apps kalender konferenz Optionen in Google Kalender hochladen, befolgen Sie diese zusätzlichen Best Practices:
onCreateFunction-LED beibehalten
Jedes onCreateFunction
die Sie in Ihrem Manifest definieren, wird synchron aufgerufen, wenn ein Nutzer versucht,
eine Konferenzlösung dieses Typs erstellen. Stellen Sie sicher, dass diese Funktionen
der für die Erstellung der Konferenz
mindestens erforderlich ist. Ich tue zu viel
Funktionen können die Nutzung des Add-ons verlangsamen.
Für Konferenzdaten geeignete ConferenceData-Felder verwenden
Wenn Sie
ConferenceData
können Sie Details zur Konferenz (Zugriff
Codes, Telefonnummern, PINs, URIs usw.). Achten Sie darauf, die entsprechende
Feld EntryPoint
für diese Informationen. Diese Details dürfen nicht im ConferenceData abgelegt werden.
Notizen ein.
Dem Google Kalender-Termin keine Konferenzdetails hinzufügen
Für das Add-on müssen keine Informationen zum erstellten Drittanbieter hinzugefügt werden. Konferenzen zur Terminbeschreibung in Google Kalender hinzufügen. Google Kalender bietet bei Bedarf automatisch anpassen.