Tworzenie dodatku do Google Workspace przy użyciu Node.js

Utwórz dodatki do Google Workspace w Cloud Functions za pomocą środowiska wykonawczego Node.js.

Cele

  • skonfigurować środowisko,
  • Utwórz i wdróż funkcję w Cloud Functions.
  • Utwórz i wdróż dodatek.
  • Zainstaluj dodatek.

Wymagania wstępne

Konfigurowanie środowiska

Otwieranie projektu Cloud w konsoli Google Cloud

  1. W konsoli Google Cloud otwórz stronę Wybierz projekt.

    Wybierz projekt Cloud

  2. Wybierz projekt Google Cloud, którego chcesz użyć. Możesz też kliknąć Utwórz projekt i postępować zgodnie z instrukcjami wyświetlanymi na ekranie. Jeśli tworzysz projekt Google Cloud, konieczne może być włączenie dla niego płatności.

Konfigurowanie ekranu zgody OAuth

Dodatki do Google Workspace wymagają konfiguracji ekranu zgody. Skonfigurowanie ekranu zgody OAuth dodatku określa, co Google wyświetla użytkownikom.

  1. W konsoli Google Cloud otwórz Menu > Interfejsy API i usługi > Ekran zgody OAuth.

    Otwórz ekran zgody OAuth

  2. Jako Typ użytkownika wybierz Wewnętrzny i kliknij Utwórz.
  3. Wypełnij formularz rejestracji aplikacji, a potem kliknij Zapisz i kontynuuj.

  4. Na razie możesz pominąć dodawanie zakresów i kliknąć Zapisz i kontynuuj. W przyszłości, gdy utworzysz aplikację do użytku poza swoją organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny, a następnie dodać zakresy autoryzacji wymagane przez aplikację.

  5. Przejrzyj podsumowanie rejestracji aplikacji. Aby wprowadzić zmiany, kliknij Edytuj. Jeśli rejestracja aplikacji wygląda dobrze, kliknij Wróć do panelu.

Tworzenie i wdrażanie funkcji w Cloud Functions

  1. W terminalu lokalnym włącz Cloud Functions, Cloud Build i interfejs Google Workspace Add-ons API:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com

  2. W pustym katalogu utwórz plik function.js przy użyciu tego przykładowego kodu:

    /**
 * 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. Wdróż funkcję:

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

    Jeśli pojawi się pytanie, określ, czy nie zezwalasz na nieuwierzytelnione wywołania funkcji. Wdrożenie funkcji może zająć kilka minut.

Tworzenie wdrożenia dodatku

  1. Znajdź adres e-mail konta usługi powiązanego z dodatkiem:

    gcloud workspace-add-ons get-authorization

  2. Przypisz do konta usługi rolę cloudfunctions.invoker:

    gcloud functions add-iam-policy-binding loadHomePage \
    --role roles/cloudfunctions.invoker \
    --member serviceAccount:SERVICE_ACCOUNT_EMAIL

  3. Uzyskaj adres URL wdrożonej funkcji. Aby uzyskać adres URL, uruchom to polecenie i odszukaj pole url w sekcji httpsTrigger:

    gcloud functions describe loadHomePage

  4. Utwórz plik deployment.json za pomocą poniższego przykładowego kodu. Zastąp URL adresem URL wdrożonej funkcji z poprzedniego kroku.

    {
  "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. Utwórz wdrożenie:

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

Instalowanie dodatku

  1. Zainstaluj wdrożenie w trybie programistycznym:

    gcloud workspace-add-ons deployments install quickstart

  2. Aby wyświetlić dodatek, otwórz lub załaduj ponownie Gmaila. Poszukaj ikony zlewki na pasku narzędzi po prawej stronie.

  3. Kliknij ikonę, aby otworzyć dodatek. W razie potrzeby autoryzuj dodatek.

Opcjonalnie: wyczyść

Aby uniknąć obciążenia konta opłatami, usuń utworzone przez siebie zasoby:

  1. Odinstaluj dodatek ze swojego konta Google:

    gcloud workspace-add-ons deployments uninstall quickstart

  2. Aby uniknąć opłat za zasoby zużyte w tym krótkim wprowadzeniu, usuń projekt Cloud:

    gcloud projects delete PROJECT_ID

    Zastąp PROJECT_ID identyfikatorem projektu Cloud użytego w krótkim wprowadzeniu. Identyfikator projektu Cloud znajdziesz w konsoli Google Cloud na stronie panelu.

Dalsze kroki

Aby dodać więcej funkcji do dodatku Google Workspace, zapoznaj się z tymi przewodnikami: