Kurzanleitung für Google Workspace-Add-ons erstellen

Google Workspace-Add-ons in Cloud Functions mithilfe der Node.js-Laufzeit erstellen

Zielsetzungen

  • die Umgebung einrichten
  • Cloud Functions-Funktion erstellen und bereitstellen
  • Erstellen Sie das Add-on und stellen Sie es bereit.
  • Installieren Sie das Add-on.

Voraussetzungen

Umgebung einrichten

Cloud-Projekt in der Google Cloud Console öffnen

  1. Rufen Sie in der Google Cloud Console die Seite Projekt auswählen auf.

    Cloud-Projekt auswählen

  2. Wählen Sie das Google Cloud-Projekt aus, das Sie verwenden möchten. Oder klicken Sie auf Projekt erstellen und folgen Sie der Anleitung auf dem Bildschirm. Wenn Sie ein Google Cloud-Projekt erstellen, müssen Sie möglicherweise die Abrechnung für das Projekt aktivieren.

OAuth-Zustimmungsbildschirm konfigurieren

Für Google Workspace-Add-ons ist eine Konfiguration des Zustimmungsbildschirms erforderlich. Wenn Sie den OAuth-Zustimmungsbildschirm des Add-ons konfigurieren, legen Sie fest, was Google den Nutzern anzeigt.

  1. Rufen Sie in der Google Cloud Console das Menü auf > APIs und Dienste > OAuth-Zustimmungsbildschirm.

    Zum OAuth-Zustimmungsbildschirm

  2. Wählen Sie für Nutzertyp die Option Intern aus und klicken Sie dann auf Erstellen.
  3. Füllen Sie das App-Registrierungsformular aus und klicken Sie dann auf Speichern und fortfahren.
  4. Vorerst können Sie das Hinzufügen von Bereichen überspringen und auf Speichern und fortfahren klicken. Wenn Sie in Zukunft eine Anwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie den Nutzertyp in Extern ändern und dann die für die Anwendung erforderlichen Autorisierungsbereiche hinzufügen.

  5. Prüfen Sie die Zusammenfassung der App-Registrierung. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die Anwendungsregistrierung in Ordnung ist, klicken Sie auf Zurück zum Dashboard.

Cloud Functions-Funktionen erstellen und bereitstellen

  1. Aktivieren Sie in einem lokalen Terminal die Cloud Functions-Funktionen, Cloud Build und die Google Workspace Add-ons API:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com
    
  2. Erstellen Sie in einem leeren Verzeichnis die Datei function.js mit dem folgenden Beispielcode:

    /**
     * Cloud Function that loads the homepage for a
     * Google Workspace Add-on.
     *
     * @param {Object} req Request sent from Google
     * @param {Object} res Response to send back
     */
    exports.loadHomePage = function addonsHomePage (req, res) {
      res.send(createAction());
    };
    
    /** Creates a card with two widgets. */
    function createAction() {
      return {
        "action": {
          "navigations": [
            {
              "pushCard": {
                "header": {
                  "title": "Cats!"
                },
                "sections": [
                  {
                    "widgets": [
                      {
                        "textParagraph": {
                          "text": "Your random cat:"
                        }
                      },
                      {
                        "image": {
                          "imageUrl": "https://cataas.com/cat"
                         }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      };
    }
    
  3. Die Funktion bereitstellen:

    gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http
    

    Wenn Sie dazu aufgefordert werden, geben Sie an, dass keine nicht authentifizierten Aufrufe der Funktion zulässig sind. Es kann einige Minuten dauern, bis die Funktion bereitgestellt wird.

Add-on-Bereitstellung erstellen

  1. Suchen Sie die E-Mail-Adresse des Dienstkontos für das Add-on:

    gcloud workspace-add-ons get-authorization
    
  2. Gewähren Sie dem Dienstkonto die Rolle cloudfunctions.invoker:

    gcloud functions add-iam-policy-binding loadHomePage \
        --role roles/cloudfunctions.invoker \
        --member serviceAccount:SERVICE_ACCOUNT_EMAIL
    
  3. Rufen Sie die URL der bereitgestellten Funktion ab. Zum Abrufen der URL führen Sie den folgenden Befehl aus und suchen im Abschnitt httpsTrigger nach dem Feld url:

    gcloud functions describe loadHomePage
    
  4. Erstellen Sie die Datei deployment.json mit dem folgenden Beispielcode. Ersetzen Sie URL durch die URL der bereitgestellten Funktion aus dem vorherigen Schritt.

    {
      "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"],
      "addOns": {
        "common": {
          "name": "My HTTP Add-on",
          "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png",
          "homepageTrigger": {
            "runFunction": "URL"
          }
        },
        "gmail": {},
        "drive": {},
        "calendar": {},
        "docs": {},
        "sheets": {},
        "slides": {}
      }
    }
    
  5. Erstellen Sie die Bereitstellung:

    gcloud workspace-add-ons deployments create quickstart \
        --deployment-file=deployment.json
    

Add-on installieren

  1. Installieren Sie die Bereitstellung im Entwicklungsmodus:

    gcloud workspace-add-ons deployments install quickstart
    
  2. Öffnen oder aktualisieren Sie Gmail, um das Add-on zu sehen. Suchen Sie in der rechten Symbolleiste nach dem Bechersymbol.

  3. Klicken Sie auf das Symbol, um das Add-on zu öffnen. Autorisieren Sie das Add-on, wenn Sie dazu aufgefordert werden.

Optional: Bereinigen

Löschen Sie die von Ihnen erstellten Ressourcen, damit Ihrem Konto keine Gebühren in Rechnung gestellt werden:

  1. Deinstallieren Sie das Add-on aus Ihrem Google-Konto:

    gcloud workspace-add-ons deployments uninstall quickstart
    
  2. Löschen Sie das Cloud-Projekt, um Gebühren für die in dieser Kurzanleitung verwendeten Ressourcen zu vermeiden:

    gcloud projects delete PROJECT_ID
    

    Ersetzen Sie PROJECT_ID durch die ID des Cloud-Projekts, das Sie für den Schnellstart verwendet haben. Die Cloud-Projekt-ID finden Sie in der Google Cloud Console auf der Dashboard-Seite.

Nächste Schritte

Informationen zum Hinzufügen weiterer Funktionen zu Ihrem Google Workspace-Add-on finden Sie in den folgenden Anleitungen: