Ta strona została przetłumaczona przez Cloud Translation API.

Tworzenie dodatku do Google Workspace za pomocą Node.js

Tworzenie dodatków do 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

Projekt Google Cloud.
Sprawdź, czy w projekcie Cloud włączone są płatności. Dowiedz się, jak sprawdzić stan rozliczeń projektów.
Pakiet SDK Cloud jest skonfigurowany na potrzeby projektu w chmurze.

Konfigurowanie środowiska

Otwórz projekt w Google Cloud Console.

W konsoli Google Cloud otwórz stronę Wybierz projekt.
Wybierz projekt w chmurze
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 utworzysz projekt Google Cloud, może być konieczne włączenie płatności za ten projekt.

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.

W konsoli Google Cloud otwórz Menu > Google Auth platform > Branding.
Otwórz Promowanie marki
Jeśli masz już skonfigurowany Google Auth platform, możesz skonfigurować te ustawienia ekranu zgody OAuth w sekcjach Branding, Odbiorcy i Dostęp do danych. Jeśli zobaczysz komunikat Google Auth platform Jeszcze nie skonfigurowano, kliknij Rozpocznij:

W sekcji Informacje o aplikacji w polu Nazwa aplikacji wpisz nazwę aplikacji.
W sekcji Adres e-mail pomocy dla użytkowników wybierz adres e-mail, na który użytkownicy mogą pisać, jeśli mają pytania dotyczące ich zgody.
Kliknij Dalej.
W sekcji Odbiorcy wybierz Wewnętrzny.
Kliknij Dalej.
W sekcji Dane kontaktowe wpisz adres e-mail, na który będziesz otrzymywać powiadomienia o wszelkich zmianach w projekcie.
Kliknij Dalej.
W sekcji Zakończ zapoznaj się z zasadami dotyczącymi danych użytkownika w usługach interfejsów API Google i jeśli się z nimi zgadzasz, kliknij Akceptuję zasady dotyczące danych użytkownika w usługach interfejsów API Google.
Kliknij Dalej.
Kliknij Utwórz.

Na razie możesz pominąć dodawanie zakresów. W przyszłości, gdy 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

W konsoli Google Cloud kliknij Aktywuj Cloud Shell .

Aktywuj Cloud Shell

Terminal Cloud Shell otworzy się i uruchomi sesję w dolnym panelu konsoli Google Cloud.
Aby skonfigurować Cloud Shell i połączyć się z nim, kliknij Autoryzuj.

W terminalu Cloud Shell włącz Cloud Functions API, Cloud Build API, Google Workspace Add-ons API i Compute Engine API:

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

Uruchom edytor Cloud Shell, klikając Otwórz edytor na pasku narzędzi w oknie Cloud Shell.

Ten wbudowany edytor kodu umożliwia wygodne przeglądanie i edytowanie plików w tym samym środowisku, w którym tworzone i wdrażane są projekty.

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"
                     }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  };
}

W tym samym katalogu utwórz plik package.json z tym przykładowym kodem:

{
  "dependencies": {
    "@google-cloud/functions-framework": "^3.0.0"
  }
}

Aby wrócić do terminala Cloud Shell, kliknij Otwórz terminal.

Dodaj rolę Cloud Build Service Account (roles/cloudbuild.builds.builder) do domyślnego konta usługi Compute Engine.

Najpierw skonfiguruj uprawnienia konta usługi:

export PROJECT_ID=$(gcloud config get project)
export SERVICE_ACCOUNT_NAME=$(gcloud compute project-info describe \
  --format="value(defaultServiceAccount)")

Następnie przyznaj brakujące uprawnienia konta usługi:

gcloud projects add-iam-policy-binding $PROJECT_ID \
  --member="serviceAccount:$SERVICE_ACCOUNT_NAME" \
  --role="roles/cloudbuild.builds.builder"

Aby wdrożyć funkcję, uruchom to polecenie:
```
gcloud functions deploy loadHomePage --runtime nodejs22 --trigger-http
```
Jeśli pojawi się zapytanie, określ, że nie zezwalasz na nieuwierzytelnione wywołania funkcji. Wdrożenie funkcji może potrwać kilka minut.

Tworzenie wdrożenia dodatku

Znajdź adres e-mail konta usługi dla dodatku:
```
gcloud workspace-add-ons get-authorization
```

Przypisz do konta usługi rolę cloudfunctions.invoker. Zastąp SERVICE_ACCOUNT_EMAIL polem serviceAccountEmail z poprzedniego kroku.

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

Pobierz adres URL wdrożonej funkcji. Aby uzyskać adres URL, uruchom to polecenie i w sekcji httpsTrigger poszukaj pola url:
```
gcloud functions describe loadHomePage
```
Aby wrócić do edytora Cloud Shell, kliknij Otwórz edytor.

W tym samym katalogu co plik package.json utwórz plik deployment.json z tym przykładowym kodem. Zastąp URL wartością 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": {},
    "httpOptions": {
      "granularOauthPermissionSupport": "OPT_IN"
    }
  }
}

Aby utworzyć wdrożenie, wróć do terminala Cloud Shell:

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

Jak zainstalować dodatek

Zainstaluj wdrożenie w trybie deweloperskim:

gcloud workspace-add-ons deployments install quickstart

Otwórz lub ponownie załaduj Gmaila, aby wyświetlić dodatek. Na pasku narzędzi po prawej stronie poszukaj ikony z kolbą.
Kliknij ikonę, aby otworzyć dodatek. Jeśli pojawi się prośba o autoryzację, autoryzuj dodatek.

Opcjonalnie: czyszczenie

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

Odinstaluj dodatek z konta Google:

gcloud workspace-add-ons deployments uninstall quickstart

Aby uniknąć obciążenia konta opłatami za zasoby użyte w tym krótkim wprowadzeniu, usuń projekt w Cloud:
```
gcloud projects delete PROJECT_ID
```
Zastąp PROJECT_ID identyfikatorem projektu w Google Cloud, którego używasz w tym krótkim wprowadzeniu. Identyfikator projektu w Google Cloud znajdziesz w konsoli Google Cloud na stronie Panel.

Aby dodać więcej funkcji do dodatku Google Workspace, wykonaj te czynności: