Cette page a été traduite par l'API Cloud Translation.

Créer un module complémentaire Google Workspace avec Node.js
Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Créez un module complémentaire Google Workspace dans Cloud Functions à l'aide de l'environnement d'exécution Node.js.

Objectifs

configurer votre environnement ;
Créez et déployez une fonction Cloud.
Créez et déployez le module complémentaire.
Installez le module complémentaire.

Prérequis

Un projet Google Cloud.
Assurez-vous d'activer la facturation pour votre projet Cloud. Découvrez comment vérifier l'état de facturation de vos projets.
Le SDK Cloud est configuré avec le projet Cloud.

Configurer votre environnement

Ouvrez votre projet Cloud dans la console Google Cloud.

Dans la console Google Cloud, accédez à la page Sélectionner un projet.
Sélectionner un projet Cloud
Sélectionnez le projet Google Cloud que vous souhaitez utiliser. Vous pouvez également cliquer sur Créer un projet et suivre les instructions à l'écran. Si vous créez un projet Google Cloud, vous devrez peut-être activer la facturation pour ce projet.

Configurer l'écran d'autorisation OAuth

Les modules complémentaires Google Workspace nécessitent une configuration de l'écran de consentement. La configuration de l'écran de consentement OAuth de votre module complémentaire définit ce que Google affiche aux utilisateurs.

Dans la console Google Cloud, accédez à Menu > > Branding.
Accéder à "Branding"
Si vous avez déjà configuré le , vous pouvez configurer les paramètres suivants de l'écran d'autorisation OAuth dans Branding (Marquage), Audience (Audience) et Data Access (Accès aux données). Si le message Pas encore configuré s'affiche, cliquez sur Commencer:

Sous Informations sur l'application, dans Nom de l'application, saisissez un nom pour l'application.
Dans Adresse e-mail d'assistance utilisateur, choisissez une adresse e-mail d'assistance à laquelle les utilisateurs peuvent vous contacter s'ils ont des questions sur leur consentement.
Cliquez sur Suivant.
Sous Audience, sélectionnez Interne.
Cliquez sur Suivant.
Sous Coordonnées, saisissez une adresse e-mail à laquelle vous pourrez être informé de toute modification apportée à votre projet.
Cliquez sur Suivant.
Sous Terminer, consultez le Règlement sur les données utilisateur dans les services d'API Google et, si vous acceptez, sélectionnez J'accepte le Règlement sur les données utilisateur dans les services d'API Google.
Cliquez sur Continuer.
Cliquez sur Créer.

Pour l'instant, vous pouvez ignorer l'ajout d'autorisations. À l'avenir, lorsque vous créerez une application à utiliser en dehors de votre organisation Google Workspace, vous devrez définir le type d'utilisateur sur Externe. Ajoutez ensuite les champs d'application d'autorisation dont votre application a besoin. Pour en savoir plus, consultez le guide complet Configurer le consentement OAuth.

Créer et déployer une fonction Cloud

Dans la console Google Cloud, cliquez sur Activer Cloud Shell .

Activer Cloud Shell

Le terminal Cloud Shell s'ouvre et lance une session dans le volet inférieur de la console Google Cloud.
Cliquez sur Autoriser pour provisionner et vous connecter à Cloud Shell.

Dans le terminal Cloud Shell, activez l'API Cloud Functions, l'API Cloud Build, l'API des modules complémentaires Google Workspace et l'API Compute Engine:

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

Lancez l'éditeur Cloud Shell en cliquant sur Ouvrir l'éditeur dans la barre d'outils de la fenêtre Cloud Shell.

Cet éditeur de code intégré offre la commodité de visualiser et de modifier des fichiers dans le même environnement où les projets sont créés et déployés.

Dans le répertoire vide, créez le fichier function.js avec l'exemple de code suivant:

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

Dans le même répertoire, créez le fichier package.json avec l'exemple de code suivant:

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

Revenez au terminal Cloud Shell en cliquant sur Ouvrir le terminal.

Ajoutez le rôle Cloud Build Service Account (roles/cloudbuild.builds.builder) au compte de service Compute Engine par défaut.

Commencez par configurer l'autorisation du compte de service:

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

Accordez ensuite l'autorisation de compte de service manquante:

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

Exécutez la commande suivante pour déployer la fonction :
```
gcloud functions deploy loadHomePage --runtime nodejs22 --trigger-http
```
Si vous y êtes invité, indiquez que vous n'autorisez pas les appels non authentifiés de la fonction. Le déploiement de la fonction peut prendre quelques minutes.

Créer un déploiement de module complémentaire

Recherchez l'adresse e-mail du compte de service du module complémentaire:
```
gcloud workspace-add-ons get-authorization
```

Attribuez au compte de service le rôle cloudfunctions.invoker. Remplacez SERVICE_ACCOUNT_EMAIL par le champ serviceAccountEmail de l'étape précédente.

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

Obtenez l'URL de la fonction déployée. Pour obtenir l'URL, exécutez la commande suivante et recherchez le champ url sous la section httpsTrigger:
```
gcloud functions describe loadHomePage
```
Revenez à l'éditeur Cloud Shell en cliquant sur Ouvrir l'éditeur.

Dans le même répertoire que package.json, créez le fichier deployment.json avec l'exemple de code suivant. Remplacez URL par le url de la fonction déployée à l'étape précédente.

{
  "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": {}
  }
}

Revenez au terminal Cloud Shell pour créer le déploiement:

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

Installer le module complémentaire

Installez le déploiement en mode développement:

gcloud workspace-add-ons deployments install quickstart

Ouvrez ou actualisez Gmail pour afficher le module complémentaire. Dans la barre d'outils de droite, recherchez l'icône d'un bécher.
Cliquez sur l'icône pour ouvrir le module complémentaire. Si vous y êtes invité, autorisez le module complémentaire.

Facultatif : Effectuer un nettoyage

Pour éviter que des frais ne soient facturés sur votre compte, supprimez les ressources que vous avez créées:

Désinstallez le module complémentaire de votre compte Google:
```
gcloud workspace-add-ons deployments uninstall quickstart
```
Pour éviter que les ressources utilisées dans ce guide de démarrage rapide ne soient facturées, supprimez le projet Cloud:
```
gcloud projects delete PROJECT_ID
```
Remplacez PROJECT_ID par l'ID du projet Cloud que vous avez utilisé pour le tutoriel de démarrage. Vous trouverez l'ID du projet Cloud dans la console Google Cloud, sur la page Tableau de bord.

Étapes suivantes

Pour ajouter d'autres fonctionnalités à votre module complémentaire Google Workspace, consultez les ressources suivantes:

Créer un module complémentaire Google Workspace avec Node.js Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.