Google Workspace-Add-ons erstellen

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:

1. Legen Sie fest, in welchen Google Workspace-Anwendungen Ihr Add-on für Nutzer verfügbar sein soll.
2. Richten Sie die Projekte Ihres Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
3. Design und Verhalten des Add-ons entwerfen und konfigurieren
4. Erstellen Sie das Add-on.
5. Prüfen Sie die OAuth-Bereiche Ihres Add-ons.
6. Testen Sie das Add-on in einer oder mehreren Google Workspace-Anwendungen.
7. 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 Chat (Entwicklervorschau)
• 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.

Warnung :Wenn Sie Ihren Add-on-Projekten keine Mitbearbeiter hinzufügen, müssen Sie die Inhaberschaft übertragen, bevor das Konto des Inhabers geschlossen oder entfernt wird. Andernfalls verlieren Sie möglicherweise den Zugriff auf den Add-on-Code und die Einstellungen.

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 Konto für die Veröffentlichung muss Bearbeitungszugriff auf das Scriptprojekt haben. 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 Verhalten des Add-ons entwerfen und konfigurieren

Ü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, um loszulegen, und fügen Sie dann weitere Verfeinerungen hinzu.

Tipp:Beginnen Sie mit einer einfachen Startseitenkarte und fügen Sie dann weitere Widgets, Karten, Navigationselemente und andere Funktionen hinzu. Sie können auch Kontextkarten verwenden, die durch die Aktion eines Nutzers in der Hostanwendung ausgelöst werden, z. B. das Öffnen eines Gmail-Nachrichtenthreads oder eines Kalendertermins.

Im Google Workspace-Add-on-Styleguide finden Sie Richtlinien für die Gestaltung der Nutzeroberfläche Ihres Add-ons.

Add-on-Manifest konfigurieren

Nachdem Sie Ihr Add-on entworfen haben, können Sie mit der Implementierung des Designs im Add-on-Manifest beginnen. Im Manifest konfigurieren Sie den Großteil des Erscheinungsbildes und des Verhaltens des Add-ons, einschließlich der Google Workspace-Hostanwendungen, die das Add-on erweitert.

Weitere Informationen finden Sie unter Manifeste für Google Workspace-Add-ons.

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.

Darstellung und Verhalten der Google Chat App konfigurieren

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Vorschauprogramms für Entwickler, das Vorabzugriff auf bestimmte Funktionen gewährt.

Wenn Sie ein Add-on entwickelt haben, das Google Chat erweitert, müssen Sie die Google Chat API verwenden, um das Aussehen und Verhalten einer Chat-App zu konfigurieren. Eine entsprechende Anleitung finden Sie unter Google Chat-App konfigurieren.

Add-on erstellen

Sie müssen für das Add-on eine Kartenoberfläche implementieren. Verwenden Sie den Kartendienst von Apps Script oder geben Sie, wenn Sie in einer anderen Programmiersprache schreiben, korrekt formatierte JSON-Daten zurück, damit die Benutzeroberfläche sie als Karten rendern 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, müssen Sie auch OAuth 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 ausfüllen, aus denen die Add-on-Benutzeroberflä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.

Hinweis: Wenn du build() nicht aufrufst, nachdem du Builder-Klassen im Kartendienst verwendet hast, kommt es zu Typfehlern. Triggerfunktionen müssen beispielsweise Card-Objekte zurückgeben. Wenn stattdessen CardBuilder-Objekte zurückgegeben werden, führt dies zu einem Fehler.

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 unten vorgehen. Sie müssen also diese Konstruktionsreihenfolge verwenden:

1. Erstellen Sie das Widget.
2. Fügen Sie das Widget dem Bereich „Karte“ hinzu.
3. Wiederholen Sie diesen Schritt, bis der Kartenbereich alle Widgets enthält.
4. Fügen Sie der Karte den Kartenabschnitt hinzu.

Das ist erforderlich, da Sie einer Karte oder einem Kartenbereich eine Kopie des Widgets hinzufügen. Änderungen, die Sie nach dem Hinzufügen an das Widgetobjekt vornehmen, werden nicht auf der endgültigen Karte berücksichtigt.

Warnung :Fügen Sie einer Karte oder einem Kartenbereich erst ein Widget hinzu, wenn Sie sie fertig erstellt haben. Fügen Sie einer Karte erst dann einen Kartenbereich hinzu, wenn sie vollständig mit Widgets gefüllt ist. Ändern Sie Widgets oder Bereiche nicht, nachdem Sie sie hinzugefügt haben. Wenn Sie ein hinzugefügtes Widget ändern möchten, müssen Sie den Abschnitt oder die Karte, dem bzw. der es hinzugefügt wurde, neu erstellen.

Universelle Aktionen

Mit universellen Aktionen können Sie kontextunabhängige Funktionen bereitstellen. Universelle Aktionen sind Menüpunkte, die unabhängig von der angezeigten Karte in der Add-on-Benutzeroberfläche verfügbar sind. 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 Add-on-Berechtigungen explizit fest, damit das Add-on die möglichst restriktiven Berechtigungen verwendet. Sie legen im Manifest des Add-ons fest, welche Bereiche Ihr 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 sein Aussehen und Verhalten in den Hostanwendungen testen, die es erweitert. Sie sollten prüfen, ob sich das Add-on bei verschiedenen Kontexten und Nutzeraktionen wie erwartet verhält.

In den folgenden Anleitungen erfahren Sie, wie Sie Ihr Add-on testen:

• Google Workspace-Add-ons von Apps Script testen und debuggen
• HTTP-Add-ons für Google Workspace testen und debuggen
• Interaktive Funktionen für Google Chat-Apps 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. Lesen Sie sich die Übersicht zur Veröffentlichung durch, bevor Sie mit dem Vorgang beginnen. 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 durchlaufen.

Weitere Informationen finden Sie unter Google Workspace-Add-on veröffentlichen.