Tworzenie dodatku do Google Workspace za pomocą Node.js

Tworzenie dodatków Google Workspace w Cloud Functions przy użyciu ś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 płatności.

Konfigurowanie ekranu zgody OAuth

Dodatki Google Workspace wymagają konfiguracji ekranu z prośbą o zgodę. Konfiguracja ekranu zgody OAuth w Twoim dodatku określa, co Google wyświetla użytkownikom.

  1. W konsoli Google Cloud otwórz Menu  > > Identyfikacja marki.

    Przejdź do sekcji Promowanie marki

  2. Jeśli masz już skonfigurowany projekt , możesz skonfigurować te ustawienia ekranu zgody OAuth: Markowanie, Odbiorcy i Dostęp do danych. Jeśli zobaczysz komunikat nie skonfigurowano, kliknij Rozpocznij:
    1. W sekcji Informacje o aplikacji w polu Nazwa aplikacji wpisz nazwę aplikacji.
    2. W sekcji Adres e-mail zespołu pomocy wybierz adres e-mail zespołu pomocy, na który użytkownicy będą mogli się z Tobą kontaktować w sprawie pytań dotyczących zgody.
    3. Kliknij Dalej.
    4. W sekcji Odbiorcy wybierz Wewnętrzny.
    5. Kliknij Dalej.
    6. W sekcji Dane kontaktowe wpisz adres e-mail, na który będą wysyłane powiadomienia o zmianach w projekcie.
    7. Kliknij Dalej.
    8. W sekcji Zakończ zapoznaj się z zasadami dotyczącymi danych użytkownika w usługach interfejsu API Google, a potem, jeśli się z nimi zgadzasz, kliknij Akceptuję zasady dotyczące danych użytkownika w usługach interfejsu API Google.
    9. Kliknij Dalej.
    10. Kliknij Utwórz.
  3. Na razie możesz pominąć dodawanie zakresów. Gdy w przyszłości będziesz tworzyć aplikację do użytku poza organizacją Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny. Następnie dodaj zakresy autoryzacji wymagane przez aplikację. Więcej informacji znajdziesz w pełnym przewodniku Konfigurowanie zgody OAuth.

Tworzenie i wdrażanie funkcji w Cloud Functions

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

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

  2. W pustym katalogu utwórz plik function.js z tym przykładowym kodem:

    /**
 * 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ę prośba, określ, że nie zezwalasz na nieuwierzytelnione wywołania funkcji. Wdrożenie funkcji może potrwać kilka minut.

Tworzenie wdrożenia dodatku

  1. Znajdź adres e-mail konta usługi dla dodatku:

    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. Pobierz adres URL wdrożonej funkcji. Aby uzyskać adres URL, uruchom to polecenie i znajdź pole url w sekcji httpsTrigger:

    gcloud functions describe loadHomePage

  4. Utwórz plik deployment.json z poniższym przykładowym kodem. 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

Jak zainstalować dodatek

  1. Zainstaluj wdrożenie w trybie deweloperskim:

    gcloud workspace-add-ons deployments install quickstart

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

  3. Kliknij ikonę, aby otworzyć dodatek. Jeśli pojawi się taka prośba, autoryzuj dodatek.

Opcjonalnie: oczyszczenie

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ąć obciążenia konta opłatami za zasoby wykorzystane w tym samouczku, usuń projekt Cloud:

    gcloud projects delete PROJECT_ID

    Zastąp PROJECT_ID identyfikatorem projektu Cloud użytego w samouczku. Identyfikator projektu Cloud znajdziesz w konsoli Google Cloud na stronie Panel.

Dalsze kroki

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