Wenn Sie ein neues Google Workspace-Add-on erstellen möchten, gehen Sie so vor:
- Richten Sie die Projekte des Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
- Design und Funktionsweise des Add-ons gestalten
- Konfigurieren Sie das Projektmanifest oder die Bereitstellungsressource des Add-ons.
- Schreiben Sie Code, um die Darstellung und das Verhalten des Add-ons zu definieren.
- Überprüfen Sie die OAuth-Bereiche des Add-ons.
- Testen Sie das Add-on in den Hostanwendungen, die es erweitert.
- Veröffentlichen Sie das Add-on.
Projekte für das Add-on einrichten und Inhaber und Mitbearbeiter auswählen
Wenn Sie Ihr Add-on in Apps Script erstellen, erstellen Sie sowohl ein Apps Script-Projekt als auch ein Google Cloud-Projekt. Wenn Sie Ihr Add-on in einer anderen Sprache als Apps Script erstellen, müssen Sie nur ein Google Cloud-Projekt erstellen.
Bevor Sie mit der Add-on-Entwicklung beginnen, wählen Sie ein einzelnes Nutzerkonto aus, um die Projekte zu besitzen und zu entscheiden, welche anderen Konten Mitbearbeiter sind. Der Inhaber der Projekte erstellt und verwaltet die Projektdateien und die zugehörigen Einstellungen, während Mitbearbeiter beim Programmieren und Testen helfen können.
Apps Script-Projekte
Sie können die Apps Script-Projektdateien des Add-ons in einer geteilten Ablage erstellen, sodass kein einzelnes Konto die alleinige Inhaberschaft hat. Wenn Sie die Add-on-Skriptdatei in einer geteilten Ablage platzieren, können Sie ganz einfach dafür sorgen, dass mehrere Mitbearbeiter immer Zugriff auf das Skriptprojekt haben.
Wenn Sie ein Add-on veröffentlichen, fungiert ein einzelnes Nutzerkonto als Publisher. Das Verlagskonto muss Bearbeitungszugriff auf das Skriptprojekt haben, aber nicht der Inhaber sein.
Google Cloud-Projekte
Wir empfehlen, Dem Cloud-Projekt des Add-ons Mitbearbeiter hinzuzufügen. So kann immer jemand aus Ihrem Team auf die Cloud-Einstellungen des Add-ons zugreifen.
Design und Funktionsweise Ihres Add-ons gestalten
Legen Sie vor dem Erstellen des Add-ons fest, wie es aussehen soll und wie es sich verhalten soll. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen anbieten soll. Beginnen Sie mit einem einfachen Design und fügen Sie dann weitere Optimierungen hinzu.
Im Google Workspace-Add-on-Styleguide finden Sie Richtlinien zur Gestaltung der Add-on-Nutzererfahrung.
Add-on-Projektmanifest konfigurieren
In Apps Script-Projekten ist das Projektmanifest eine spezielle JSON-Datei. Er gibt eine Vielzahl von Details zum Projekt an, z. B. seine Bibliotheksabhängigkeiten. Bei Google Workspace-Add-ons enthält das Manifest auch die grundlegenden Informationen, die die Hostanwendung benötigt, um das Add-on korrekt anzuzeigen.
Weitere Informationen zur Konfiguration des Manifests Ihres Add-ons in Apps Script finden Sie unter Manifeste.
Wenn Sie Code und Features zu Ihrem Add-on hinzufügen, bearbeiten Sie das Manifest nach Bedarf, um die erforderliche Darstellung und das Verhalten des Add-ons zu erzeugen.
Add-on codieren
Sie müssen eine kartenbasierte Schnittstelle für das Add-on implementieren. Verwenden Sie den Kartendienst von Apps Script. Wenn Sie in einer anderen Codesprache schreiben, müssen Sie das JSON-Format zurückgeben, damit die Schnittstelle als Karten gerendert werden kann.
Außerdem müssen Sie alle Triggerfunktionen implementieren, die im Add-on-Manifest angegeben sind. Wenn das Add-on über OAuth eine Verbindung zu einem Drittanbieterdienst außerhalb von Google herstellt, müssen Sie auch OAuth für diesen Dienst konfigurieren.
Karten erstellen
Zum Definieren einer Add-on-Benutzeroberfläche erstellen Sie Card-Objekte und füllen sie mit Widgets. In Ihrem Manifest angegebene Triggerfunktionen müssen entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten zurückgeben, die unterschiedliche „Seiten“ der Add-on-Schnittstelle darstellen. Ihr Add-on kann auch als Reaktion auf Nutzeraktionen neue Karten erstellen und anzeigen.
In Apps Script erstellen Sie Karten mit der Klasse CardBuilder. Für jede Karte sind ein CardHeader und ein oder mehrere CardSections-Elemente erforderlich.
Sie sollten jeden Kartenabschnitt mit den einzelnen Widgets füllen, aus denen die Add-on-Oberfläche besteht. Interaktions-Widgets sind normalerweise mit Aktionen verknüpft, um ihr Interaktionsverhalten zu definieren.
Nachdem Sie Ihrer Karte über die CardBuilder alle Abschnitte und Widgets hinzugefügt haben, müssen Sie CardBuilder.build() aufrufen, um das entsprechende Card-Objekt zu erstellen.
Sie können auch andere integrierte Apps Script-Dienste wie CalendarApp verwenden, um Informationen abzurufen, die in den von Ihnen erstellten Add-on-Karten angezeigt werden sollen. Sie können Daten verwenden, die von Nicht-Google-Diensten abgerufen wurden.
Wenn Ihre Google Workspace-Add-ons Zugriff auf Nicht-Google APIs benötigen, für die OAuth erforderlich ist, müssen Sie diesen Dienst konfigurieren und eine Verbindung dazu herstellen. Weitere Informationen finden Sie im Leitfaden zum Herstellen einer Verbindung mit Nicht-Google-Diensten.
Bauauftrag
Wenn Sie eine Karte erstellen, müssen Sie von oben beginnen. Sie müssen also diese Konstruktionsreihenfolge verwenden:
- Erstellen Sie das Widget.
- Widget zum Bereich „Karte“ hinzufügen
- Wiederholen Sie den Vorgang, bis alle Widgets im Kartenbereich angezeigt werden.
- Fügen Sie der Karte den Kartenabschnitt hinzu.
Dies ist erforderlich, da durch Hinzufügen eines Widgets zu einer Karte oder einem Kartenabschnitt tatsächlich eine Kopie dieses Widgets hinzugefügt wird. Änderungen, die Sie nach dem Hinzufügen am Widget-Objekt vornehmen, werden nicht auf der endgültigen Karte widergespiegelt.
Universelle Aktionen
Sie können universelle Aktionen für kontextunabhängige Funktionen verwenden. Universelle Aktionen sind Menüelemente, die in der Add-on-UI verfügbar sind, unabhängig von der aktuell angezeigten Karte. Alle definierten universellen Aktionen werden immer im Kartenmenü des Add-ons angezeigt.
Weitere Informationen finden Sie unter Universelle Aktionen.
Add-on-OAuth-Umfänge prüfen
Bereiche definieren, welche Aktionen das Add-on im Namen eines Nutzers ausführen darf. Es hat sich bewährt, dass Add-ons nur Bereiche für Aktionen enthalten, die sie in der richtigen Reihenfolge haben müssen.
In Add-on-Projekten legen Sie die Add-on-Bereiche explizit fest, damit das Add-on den Bereich mit der geringsten Berechtigung verwendet. Sie legen im Manifest des Add-ons fest, welche Bereiche das Add-on verwendet.
Weitere Informationen finden Sie unter Umfang.
Add-on testen
Sie können nicht veröffentlichte Add-ons testen, indem Sie zuerst das nicht veröffentlichte Add-on installieren. Nach der Installation und Autorisierung können Sie das Add-on in Ihrem Konto verwenden und dessen Darstellung und Verhalten in den erweiterten Hostanwendungen testen. Sie sollten prüfen, ob sich das Add-on für Kontexte und Nutzeraktionen wie erwartet verhält.
Weitere Informationen finden Sie unter Google Workspace-Add-ons testen.
Add-on veröffentlichen
Wenn Sie Ihr Add-on veröffentlichen, ist es öffentlich oder nur für Nutzer in Ihrer Domain verfügbar. Bevor Sie mit der Veröffentlichung beginnen, lesen Sie die Veröffentlichungsübersicht. Die Veröffentlichung ist ein komplexer Prozess, der Vorbereitung und Zeit erfordert.
Google Workspace-Add-ons werden im Google Workspace Marketplace veröffentlicht. Öffentlich verfügbare Add-ons müssen App-Überprüfung durchlaufen, bevor sie veröffentlicht werden.
Weitere Informationen finden Sie unter Google Workspace-Add-on veröffentlichen.
Beispiel für ein Google Workspace-Add-on
Damit Sie verstehen, wie Google Workspace-Add-ons aufgebaut sind, wird im Google Workspace-Add-on „Cats“ beschrieben, wie Sie ein einfaches Google Workspace-Add-on erstellen. Dazu gehören Startseiten, die Kartennavigation und Verbindungen zu Drittanbieterdiensten. Nachdem Sie die Kurzanleitung abgeschlossen haben, können Sie das Add-on installieren und den Code testen.