Auf dieser Seite finden Sie einen Überblick darüber, wie Sie Google Workspace-Add-ons entwerfen, erstellen und veröffentlichen. In dieser Übersicht werden die folgenden Schritte erläutert:
- Legen Sie fest, in welchen Google Workspace-Anwendungen Ihr Add-on für Nutzer verfügbar sein soll.
- Richten Sie die Projekte des Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
- Aussehen und Verhalten des Add-ons entwerfen
- Konfigurieren Sie das Projektmanifest oder die Bereitstellungsressource des Add-ons.
- Schreiben Sie Code, um das Aussehen und Verhalten des Add-ons zu definieren.
- Prüfen Sie die OAuth-Bereiche Ihres Add-ons.
- Testen Sie das Add-on in einer oder mehreren Google Workspace-Anwendungen.
- Veröffentlichen Sie das Add-on.
Google Workspace-Hostanwendungen auswählen
Sie können Google Workspace-Add-ons so konfigurieren, dass sie in den folgenden Google Workspace-Hostanwendungen angezeigt werden:
- Gmail
- Google Kalender
- Google Docs
- Google Drive
- Google Sheets
- Google Präsentationen
Informationen zum Erstellen von Apps für Google Workspace finden Sie unter Google Workspace-Benutzeroberfläche erweitern.
Projekte für Ihr Add-on einrichten und Inhaber und Mitbearbeiter auswählen
Wenn Sie Ihr Add-on in Apps Script erstellen, erstellen Sie sowohl ein Apps Script- 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 Entwicklung des Add-ons beginnen, wählen Sie ein einzelnes Nutzerkonto aus, das Inhaber der Projekte sein soll, und legen Sie fest, welche anderen Konten Mitbearbeiter sind. Der Inhaber der Projekte erstellt und verwaltet die Projektdateien und die zugehörigen Einstellungen, während Mitbearbeiter beim Codieren und Testen helfen können.
Apps Script-Projekte
Sie können die Apps Script-Projektdateien Ihres Add-ons in einem freigegebenen Drive-Ordner erstellen, damit kein einzelnes Konto die alleinige Inhaberschaft hat. Wenn Sie die Scriptdatei des Add-ons in einer freigegebenen Ablage ablegen, haben mehrere Mitbearbeiter Zugriff auf das Scriptprojekt.
Wenn Sie ein Add-on veröffentlichen, fungiert ein einzelnes Nutzerkonto als Publisher. Das veröffentlichende Konto muss Bearbeitungszugriff auf das Skriptprojekt haben, aber es muss nicht der Inhaber sein.
Informationen zum Erstellen eines Apps Script-Projekts finden Sie unter Script-Projekte.
Google Cloud-Projekte
Wir empfehlen, Mitbearbeiter zum Cloud-Projekt des Add-ons hinzuzufügen. So kann immer jemand in Ihrem Team auf die Cloud-Einstellungen des Add-ons zugreifen.
Weitere Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.
Aussehen und Funktionsweise des Add-ons entwerfen
Überlegen Sie sich, wie Ihr Add-on aussehen und wie es sich verhalten soll, bevor Sie mit dem Erstellen beginnen. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen bieten soll. Beginnen Sie mit einem einfachen Design und nehmen Sie dann weitere Optimierungen vor.
Im Google Workspace-Add-on-Styleguide finden Sie Richtlinien für die Gestaltung der Nutzeroberfläche Ihres Add-ons.
Manifest des Add-on-Projekts konfigurieren
In Apps Script-Projekten ist das Projektmanifest eine spezielle JSON-Datei. Es enthält eine Vielzahl von Details zum Projekt, z. B. die 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 zum Konfigurieren des Manifests Ihres Add-ons in Apps Script finden Sie unter Manifeste.
Wenn Sie Ihrem Add-on Code und Funktionen hinzufügen, bearbeiten Sie das Manifest nach Bedarf, um das gewünschte Erscheinungsbild und Verhalten des Add-ons zu erzielen.
Add-on programmieren
Sie müssen für das Add-on eine Kartenoberfläche implementieren. Verwenden Sie den Kartendienst von Apps Script. Wenn Sie in einer anderen Codesprache schreiben, geben Sie richtig formatiertes JSON zurück, damit die Schnittstelle als Karten dargestellt werden kann.
Außerdem müssen Sie alle im Add-on-Manifest angegebenen Triggerfunktionen implementieren. Wenn Ihr Add-on über OAuth eine Verbindung zu einem Drittanbieterdienst herstellt, der nicht von Google stammt, müssen Sie OAuth auch für diesen Dienst konfigurieren.
Karten erstellen
Sie definieren die Benutzeroberfläche eines Add-ons, indem Sie Card-Objekte erstellen und mit Widgets füllen. In Ihrem Manifest angegebene Triggerfunktionen müssen entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten zurückgeben, die verschiedene „Seiten“ der Add-on-Benutzeroberfläche darstellen. Ihr Add-on kann auch neue Karten erstellen und anzeigen, wenn Nutzeraktionen ausgeführt werden.
In Apps Script erstellen Sie Karten mit der Klasse CardBuilder. Für jede Karte ist eine CardHeader und eine oder mehrere CardSections erforderlich. Sie sollten jeden Kartenbereich mit den einzelnen Widgets füllen, aus denen die Add-on-Oberfläche besteht. Interaktions-Widgets sind in der Regel mit Aktionen verknüpft, um ihr Interaktionsverhalten zu definieren.
Nachdem Sie Ihrer Karte über 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 eingebaute 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 aus Diensten von Drittanbietern abgerufen wurden.
Wenn Ihr Add-on Zugriff auf APIs von Drittanbietern benötigt, 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 zu Drittanbieterdiensten.
Bauauftrag
Beim Erstellen einer Karte müssen Sie von oben nach oben aufbauen. Sie müssen also diese Konstruktionsreihenfolge verwenden:
- Erstellen Sie das Widget.
- Fügen Sie das Widget dem Bereich „Karte“ hinzu.
- Wiederholen Sie diesen Schritt, bis der Kartenbereich alle Widgets enthält.
- Fügen Sie der Karte den Kartenabschnitt hinzu.
Das ist erforderlich, da Sie einer Karte oder einem Kartenbereich immer eine Kopie des Widgets hinzufügen. Änderungen, die Sie nach dem Hinzufügen an das Widgetobjekt vornehmen, werden nicht auf der endgültigen Karte angezeigt.
Universelle Aktionen
Mit universellen Aktionen können Sie kontextunabhängige Funktionen bereitstellen. Universelle Aktionen sind Menüelemente, die in der Add-on-UI verfügbar sind, unabhängig davon, welche Karte angezeigt wird. Alle definierten universellen Aktionen werden immer im Kartenmenü des Add-ons angezeigt.
Weitere Informationen finden Sie unter Universelle Aktionen.
OAuth-Bereiche des Add-ons prüfen
Mit Bereichen wird festgelegt, welche Aktionen das Add-on im Namen eines Nutzers ausführen darf. Es wird empfohlen, dass Add-ons nur Berechtigungen für Aktionen haben, die für ihre Funktion erforderlich sind.
Legen Sie in Add-on-Projekten die Berechtigungen für das Add-on explizit fest, damit es nur die striktesten Berechtigungen verwendet. Sie legen im Manifest des Add-ons fest, welche Bereiche Ihr Add-on verwendet.
Weitere Informationen finden Sie unter Bereiche.
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 seine Darstellung und sein Verhalten in den erweiterten Hostanwendungen testen. Sie sollten prüfen, ob sich das Add-on bei verschiedenen Kontexten 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, wird es für andere Nutzer verfügbar gemacht, entweder öffentlich oder nur für Nutzer in Ihrer Domain. Vor der Veröffentlichung solltest du dir die Publikationsübersicht durchlesen. 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 vor der Veröffentlichung eine App-Überprüfung bestehen.
Weitere Informationen finden Sie unter Google Workspace-Add-on veröffentlichen.