Wenn Sie ein neues Google Workspace-Add-on erstellen möchten, gehen Sie so vor:
- Richten Sie die Projekte Ihres Add-ons ein und wählen Sie einen Inhaber und Mitbearbeiter aus.
- Entwerfen Sie Aussehen und Verhalten Ihres Add-ons.
- Konfigurieren Sie das Projektmanifest oder die Bereitstellungsressource des Add-ons.
- Schreiben Sie Code, um Aussehen und Verhalten des Add-ons zu definieren.
- Überprüfen Sie die OAuth-Bereiche des Add-ons.
- Testen Sie das Add-on in den erweiterten Hostanwendungen.
- 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, das Eigentümer der Projekte ist, und entscheiden Sie, welche anderen Konten Mitbearbeiter sind. Der Inhaber der Projekte erstellt und verwaltet die Projektdateien und die zugehörigen Einstellungen, während die Mitbearbeiter beim Programmieren und Testen helfen können.
Apps Script-Projekte
Sie können die Apps Script-Projektdateien Ihres Add-ons in einer geteilten Ablage erstellen, sodass kein einzelnes Konto die alleinige Inhaberschaft hat. Wenn Sie Ihre Add-on-Skriptdatei in einer geteilten Ablage ablegen, haben mehrere Mitbearbeiter Zugriff auf das Skriptprojekt.
Wenn Sie ein Add-on veröffentlichen, fungiert ein einzelnes Nutzerkonto als Publisher. Das veröffentlichende Konto muss Bearbeitungszugriff auf das Skriptprojekt haben, aber nicht der Inhaber sein.
Informationen zum Erstellen eines Apps Script-Projekts finden Sie unter Script-Projekte.
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.
Aussehen und Verhalten von Add-ons gestalten
Entscheiden Sie, wie Ihr Add-on aussehen und wie es funktionieren soll, bevor Sie mit dem Erstellen beginnen. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen anbieten sollte. Beginnen Sie mit einem einfachen Design und fügen Sie dann weitere Optimierungen hinzu.
Im Styleguide für Google Workspace-Add-ons finden Sie Richtlinien für die Gestaltung des Add-ons.
Add-on-Projektmanifest konfigurieren
In Apps Script-Projekten ist das Projektmanifest eine spezielle JSON-Datei. Sie gibt eine Vielzahl von Details über das Projekt an, z. B. seine Bibliotheksabhängigkeiten. Bei Google Workspace-Add-ons enthält das Manifest auch die grundlegenden Informationen, die die Host-Anwendung benötigt, um das Add-on korrekt anzuzeigen.
Weitere Informationen zur Konfiguration des Manifests Ihres Add-ons in Apps Script finden Sie unter Manifeste.
Bearbeiten Sie beim Hinzufügen von Code und Features zu Ihrem Add-on das Manifest nach Bedarf, um die erforderliche Darstellung und das erforderliche Verhalten des Add-ons zu erzeugen.
Add-on programmieren
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, geben Sie das JSON-Format zurück, damit die Schnittstelle als Karten gerendert wird.
Außerdem müssen Sie alle Triggerfunktionen implementieren, die im 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 OAuth auch für diesen Dienst konfigurieren.
Karten konstruieren
Sie definieren eine Add-on-Benutzeroberfläche, indem Sie Card-Objekte erstellen und mit Widgets füllen. Die im Manifest angegebenen Triggerfunktionen müssen entweder ein einzelnes Card-Objekt oder ein Array von Card-Objekten zurückgeben, die verschiedene „Seiten“ der Add-on-Oberfläche darstellen. Das Add-on kann auch neue Karten als Reaktion auf Nutzeraktionen erstellen und anzeigen.
In Apps Script erstellen Sie Karten mit der Klasse CardBuilder. Für jede Karte sind ein CardHeader und eine oder mehrere CardSections erforderlich. Sie sollten in jeden Kartenabschnitt die einzelnen Widgets eintragen, 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 CardBuilder alle Bereiche 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 auf den von Ihnen erstellten Add-on-Karten angezeigt werden sollen.
Sie können Daten verwenden, die aus Diensten abgerufen wurden, die nicht von Google stammen.
Wenn Ihre Google Workspace-Add-ons Zugriff auf APIs von Drittanbietern benötigen, für die OAuth erforderlich ist, müssen Sie diesen Dienst konfigurieren und eine Verbindung zu diesem Dienst herstellen. Weitere Informationen finden Sie im Leitfaden zum Herstellen einer Verbindung zu Nicht-Google-Diensten.
Bauauftrag
Wenn Sie eine Karte erstellen, müssen Sie von oben nach oben aufbauen. Das heißt, Sie müssen diese Konstruktionsreihenfolge verwenden:
- Erstellen Sie das Widget.
- Widget zur Karte hinzufügen.
- Wiederholen Sie diesen Schritt, bis der Kartenabschnitt alle Widgets enthält.
- Fügen Sie der Karte den Kartenabschnitt hinzu.
Dies ist erforderlich, da Sie beim Hinzufügen eines Widgets zu einer Karte oder einem Kartenbereich tatsächlich eine Kopie dieses Widgets hinzufügen. Alle Änderungen, die Sie nach dem Hinzufügen am Widget-Objekt vornehmen, werden nicht auf der endgültigen Karte angezeigt.
Universelle Aktionen
Sie können universelle Aktionen verwenden, um kontextunabhängige Funktionen bereitzustellen. Universelle Aktionen sind Menüelemente, die unabhängig von der angezeigten Karte in der Add-on-UI 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 überprüfen
Mit Bereichen wird definiert, welche Aktionen das Add-on im Namen eines Nutzers ausführen darf. Es hat sich bewährt, für Add-ons nur Bereiche für Aktionen zu haben, die für die Funktion erforderlich sind.
Legen Sie in Add-on-Projekten die Add-on-Bereiche explizit fest. So sorgen Sie dafür, dass das Add-on nur die geringstmöglichen Berechtigungen verwendet. Welche Bereiche Ihr Add-on verwendet, legen Sie im Add-on-Manifest fest.
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 seine Darstellung und sein Verhalten in den erweiterten Hostanwendungen testen. Prüfen Sie, ob sich das Add-on in Bezug auf Kontexte und Nutzeraktionen wie erwartet verhält.
Weitere Informationen finden Sie unter Add-ons für Google Workspace testen.
Add-on veröffentlichen
Durch die Veröffentlichung Ihres Add-ons wird es für andere Personen verfügbar gemacht, entweder öffentlich oder nur für Nutzer in Ihrer Domain. Bevor du mit der Veröffentlichung beginnst, solltest du dir die Publikationsübersicht ansehen. 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 die App-Überprüfung durchlaufen.
Weitere Informationen finden Sie unter Google Workspace-Add-on veröffentlichen.