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.
- Gestalten Sie das Erscheinungsbild und das Verhalten des Add-ons.
- Konfigurieren Sie das Projektmanifest oder die Bereitstellungsressource des Add-ons.
- Schreiben Sie Code, um das Aussehen und das Verhalten des Add-ons zu definieren.
- Prü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 des Add-ons einrichten und einen Inhaber und Mitbearbeiter auswählen
Wenn Sie das 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 für die Projekte aus und entscheiden Sie, welche anderen Konten Mitbearbeiter sind. Der Projektinhaber 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 Ihres Add-ons in einer geteilten Ablage erstellen, sodass kein einzelnes Konto alleinige Eigentümerschaft 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 es muss 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. Dadurch wird sichergestellt, dass jemand in Ihrem Team immer auf die Cloud-Einstellungen des Add-ons zugreifen kann.
Informationen zum Erstellen eines Google Cloud-Projekts finden Sie unter Google Cloud-Projekt erstellen.
Erscheinungsbild und Funktionsweise des Add-ons entwerfen
Entscheiden Sie, wie das Add-on aussehen und wie es sich verhalten soll, bevor Sie mit der Erstellung beginnen. Überlegen Sie, für welche Anwendungsfälle das Add-on Lösungen bieten sollte. Beginnen Sie mit einem einfachen Design und nehmen Sie dann weitere Optimierungen vor.
Im Styleguide für Google Workspace-Add-ons finden Sie Richtlinien dazu, wie Sie die Nutzerfreundlichkeit des Add-ons gestalten.
Manifest des Add-on-Projekts konfigurieren
In Apps Script-Projekten ist das Projektmanifest eine spezielle JSON-Datei. Es gibt eine Vielzahl von Details zum Projekt an, z. B. seine Bibliotheksabhängigkeiten. Für Google Workspace-Add-ons enthält das Manifest auch die grundlegenden Informationen, die die Hostanwendung benötigt, um das Add-on korrekt anzuzeigen.
Ausführliche Informationen zum Konfigurieren des Manifests Ihres Add-ons in Apps Script finden Sie unter Manifeste.
Wenn Sie dem Add-on Code und Funktionen hinzufügen, bearbeiten Sie das Manifest nach Bedarf, um die Darstellung und das Verhalten des erforderlichen Add-ons zu erreichen.
Add-on programmieren
Für das Add-on musst du eine kartenbasierte Schnittstelle 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
Zum Definieren der Benutzeroberfläche eines Add-ons erstellen Sie Card-Objekte und füllen sie mit Widgets. 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-Schnittstelle darstellen. Mit dem Add-on können auch neue Karten als Reaktion auf Nutzeraktionen erstellt und angezeigt werden.
In Apps Script erstellen Sie Karten mithilfe der Klasse CardBuilder. Für jede Karte sind ein CardHeader und ein 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 normalerweise mit Aktionen verknüpft, um ihr Interaktionsverhalten zu definieren.
Nachdem du alle Abschnitte und Widgets über CardBuilder deiner Karte hinzugefügt hast, musst du 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 in den von Ihnen erstellten Add-on-Karten angezeigt werden.
Sie können Daten verwenden, die aus nicht von Google stammenden Diensten abgerufen wurden.
Wenn Ihre Google Workspace-Add-ons Zugriff auf APIs von Drittanbietern benötigen, die OAuth erfordern, müssen Sie diesen Dienst konfigurieren und eine Verbindung zu diesem Dienst herstellen. Weitere Informationen finden Sie im Leitfaden zum Herstellen einer Verbindung mit Diensten von Drittanbietern.
Bauauftrag
Beim Erstellen einer Karte müssen Sie von oben nach oben aufbauen. Das heißt, Sie müssen diese Konstruktionsreihenfolge verwenden:
- Erstellen Sie das Widget.
- Füge das Widget zum Bereich „Karte“ hinzu.
- Wiederholen Sie den Vorgang, bis der Kartenbereich alle Widgets enthält.
- Fügen Sie der Karte den Bereich „Karte“ hinzu.
Dies ist erforderlich, da beim 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 auf der letzten Karte nicht berücksichtigt.
Universelle Aktionen
Sie können universelle Aktionen verwenden, um kontextunabhängige Funktionen bereitzustellen. 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
Bereiche definieren, welche Aktionen das Add-on im Namen eines Nutzers ausführen darf. Als Best Practice wird empfohlen, dass Add-ons nur Bereiche für Aktionen haben, die sie haben müssen, damit sie funktionieren, und nicht mehr.
Legen Sie in Add-on-Projekten die Add-on-Bereiche explizit fest, damit das Add-on so wenige Bereiche wie möglich verwendet. Im Add-on-Manifest definieren Sie, welche Bereiche das 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. Prüfen Sie, ob sich das Add-on in 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, ist es entweder öffentlich oder nur für Nutzer in Ihrer Domain für andere verfügbar. 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 einer App-Überprüfung unterzogen werden.
Weitere Informationen finden Sie unter Google Workspace-Add-on veröffentlichen.