Google Workspace-Add-ons erstellen

Auf dieser Seite finden Sie eine Übersicht zum Entwerfen, Erstellen und Veröffentlichen von Google Workspace-Add-ons. In dieser Übersicht werden die folgenden Schritte erläutert:

Bestimmen Sie die Google Workspace-Anwendungen, in denen Ihr Add-on für Nutzer verfügbar sein soll.
Richten Sie die Projekte Ihres Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
Entwerfen und konfigurieren Sie das Erscheinungsbild und das Verhalten Ihres Add-ons.
Erstellen Sie das Add-on.
Überprü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.

Sie können ein Add-on mit Apps Script oder HTTP erstellen. Einen Vergleich finden Sie im Video Apps Script vs. HTTP endpoints: Which should you choose? 🤔.

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
Google Docs
Google Drive
Google Meet
Google Sheets
Google Präsentationen

Informationen zum Erstellen von Add-ons für Google Workspace-Anwendungen finden Sie unter Google Workspace-Benutzeroberfläche erweitern.

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 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 bei der Programmierung und beim Testen helfen können.

Apps Script-Projekte

Bevor Sie Ihr Add-on erstellen, lesen Sie die Apps Script Kontingente und ‑Einschränkungen, um sicherzustellen, dass Ihr Projektdesign diesen Richtlinien entspricht. Apps Script eignet sich am besten für die einfache Entwicklung von Add-ons für den persönlichen Gebrauch oder für interne Zwecke mit einer kleinen Nutzerbasis. Wenn Sie ein Add-on im großen Maßstab erstellen möchten, das viele Nutzer verarbeiten muss, eine geringe Latenz erfordert oder die vollständige Kontrolle über Ihre Infrastruktur erfordert, sollten Sie die Entwicklung in einer anderen Laufzeit umgebung in Betracht ziehen.

Sie können die Apps Script Projektdateien Ihres Add-ons in einer geteilten Ablage erstellen, sodass kein einzelnes Konto alleiniger Inhaber ist. Wenn Sie die Add-on-Scriptdatei in einer geteilten Ablage speichern, haben mehrere Mitbearbeiter Zugriff auf das Scriptprojekt.

Wenn Sie ein Add-on veröffentlichen, fungiert ein einzelnes Nutzerkonto als Herausgeber. Das Konto des Herausgebers muss Bearbeitungszugriff auf das Scriptprojekt haben, muss aber nicht der Inhaber sein.

Informationen zum Erstellen eines Apps Script-Projekts finden Sie unter Scriptprojekte.

Google Cloud-Projekte

Wir empfehlen, dem Cloud-Projekt des Add-ons Mitbearbeiter hinzuzufügen. So kann immer jemand in Ihrem Team auf die Cloud-Einstellungen des Add-ons zugreifen.

Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.

Erscheinungsbild und Verhalten des Add-ons entwerfen und konfigurieren

Legen Sie fest, wie Ihr Add-on aussehen und sich verhalten soll, bevor Sie mit der Erstellung beginnen. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen bieten soll. Beginnen Sie mit einem einfachen Design, um zuerst eine funktionierende Version zu erstellen, und fügen Sie dann weitere Verbesserungen hinzu.

Im Styleguide für Google Workspace-Add-ons finden Sie Richtlinien zum Entwerfen der Benutzeroberflä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 die meisten Aspekte des Erscheinungsbilds 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.

Erscheinungsbild und Verhalten der Google Chat-App konfigurieren

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

Add-on erstellen

Sie müssen eine kartenbasierte Benutzeroberfläche für das Add-on implementieren. Verwenden Sie den Card-Dienst von Apps Script oder geben Sie, wenn Sie in einer anderen Programmiersprache schreiben, korrekt formatiertes JSON für die Benutzeroberfläche zurück, damit sie als Karten gerendert wird.

Sie müssen auch alle Triggerfunktionen implementieren, die in dem Add-on-Manifest angegeben sind. Wenn Ihr Add-on über OAuth eine Verbindung zu einem Drittanbieterdienst herstellt, der nicht von Google stammt, müssen Sie auch OAuth für diesen Dienst konfigurieren.

Karten erstellen

Sie definieren eine Add-on-Benutzeroberfläche, indem Sie Card-Objekte erstellen und sie mit Widgets füllen. Triggerfunktionen, die in Ihrem Manifest angegeben sind, 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 Nutzer bestimmte Aktionen ausführen.

In Apps Script erstellen Sie Karten mit der CardBuilder Klasse. Jede Karte erfordert einen CardHeader und einen oder mehrere CardSections. Füllen Sie jeden Kartenabschnitt mit den einzelnen Widgets, 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 alle Abschnitte und Widgets über das CardBuilder zur Karte hinzugefügt haben, müssen Sie CardBuilder.build() aufrufen, um das entsprechende Card Objekt zu erstellen.

Sie können andere integrierte Apps Script Dienste wie CalendarApp verwenden, um Informationen abzurufen, die auf den von Ihnen erstellten Add-on-Karten angezeigt werden sollen. Sie können auch Daten verwenden, die von Diensten abgerufen wurden, die nicht von Google stammen.

Wenn Ihr Add-on Zugriff auf APIs benötigt, die nicht von Google stammen und OAuth erfordern, müssen Sie diesen Dienst konfigurieren und eine Verbindung herstellen. Weitere Informationen finden Sie in der Anleitung Verbindung zu Diensten herstellen, die nicht von Google stammen .

Erstellungsreihenfolge

Beim Erstellen einer Karte müssen Sie von oben nach unten vorgehen. Das heißt, Sie müssen diese Erstellungsreihenfolge verwenden:

Widget erstellen
Widget zum Kartenabschnitt hinzufügen
Wiederholen, bis der Kartenabschnitt alle Widgets enthält
Kartenabschnitt zur Karte hinzufügen

Das ist erforderlich, da Sie beim Hinzufügen eines Widgets zu einer Karte oder einem Kartenabschnitt tatsächlich eine Kopie dieses Widgets hinzufügen. Alle Änderungen, die Sie am Widget-Objekt vornehmen, nachdem Sie es hinzugefügt haben, werden nicht auf der endgültigen Karte berücksichtigt.

Universelle Aktionen

Mit universellen Aktionen können Sie kontextunabhängige Funktionen bereitstellen. Universelle Aktionen sind Menüelemente, die in der Add-on-Benutzeroberfläche unabhängig davon verfügbar sind, 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 überprüfen

Bereiche definieren, welche Aktionen das Add-on im Namen eines Nutzers ausführen darf. Es ist eine Best Practice, dass Add-ons nur Bereiche für Aktionen haben, die für ihre Funktion erforderlich sind.

Legen Sie in Add-on-Projekten die Add-on- Bereiche explizit fest, um sicherzustellen, dass das Add-on die restriktivsten Bereiche verwendet. Sie definieren im Add-on Manifest, 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 sein Erscheinungsbild und Verhalten in den Hostanwendungen testen, die es erweitert. Sie sollten prüfen, ob sich das Add-on in verschiedenen Kontexten und bei verschiedenen Nutzeraktionen wie erwartet verhält.

Informationen zum Testen Ihres Add-ons finden Sie in den folgenden Anleitungen:

Add-on veröffentlichen

Wenn Sie Ihr Add-on veröffentlichen, machen Sie es für andere verfügbar, entweder öffentlich oder nur für Nutzer in Ihrer Domain. Bevor Sie mit der Veröffentlichung beginnen, lesen Sie die Übersicht zur Veröffentlichung. 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 für mehr Details.