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

Guide de démarrage rapide pour créer un module complémentaire Google Workspace

Créez des modules complémentaires Google Workspace dans Cloud Functions à l'aide de l'environnement d'exécution Node.js.

Objectifs

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

Conditions préalables

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

Configurer votre environnement

Ouvrir 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 de consentement OAuth

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

Dans la console Google Cloud, accédez à Menu > API et services > Écran de consentement OAuth.
Accéder à l'écran de consentement OAuth
Sélectionnez le type d'utilisateur de votre application, puis cliquez sur Créer.
Remplissez le formulaire d'enregistrement de l'application, puis cliquez sur Enregistrer et continuer.
Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. À l'avenir, lorsque vous créerez une application destinée à être utilisée en dehors de votre organisation Google Workspace, vous devrez ajouter et valider les champs d'application d'autorisation requis par votre application.
Si vous avez sélectionné le type d'utilisateur Externe, ajoutez des utilisateurs tests :
1. Sous Utilisateurs test, cliquez sur Ajouter des utilisateurs.
2. Saisissez votre adresse e-mail et tout autre utilisateur de test autorisé, puis cliquez sur Enregistrer et continuer.
Consultez le récapitulatif d'enregistrement de votre application. Pour apporter des modifications, cliquez sur Modifier. Si l'enregistrement de l'application semble correct, cliquez sur Retour au tableau de bord.

Créer et déployer une fonction Cloud

Dans un terminal local, activez Cloud Functions, Cloud Build et l'API Google Workspace Add-ons:
```
gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com
```

Dans un répertoire vide, créez le fichier function.js à l'aide de 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"
                     }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  };
}

Déployez la fonction :
```
gcloud functions deploy loadHomePage --runtime nodejs12 --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 associé au module complémentaire:
```
gcloud workspace-add-ons get-authorization
```

Attribuez le rôle cloudfunctions.invoker au compte de service:

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 dans la section httpsTrigger:
```
gcloud functions describe loadHomePage
```

Créez le fichier deployment.json avec l'exemple de code suivant. Remplacez URL par l'URL de la fonction déployée de 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": {}
  }
}

Créez 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 une icône en forme de 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ésinstaller 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 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 démarrage rapide. Vous pouvez trouver l'ID du projet Cloud dans la console Google Cloud, sur la page Tableau de bord.

Étapes suivantes

Pour ajouter des fonctionnalités à votre module complémentaire Google Workspace, consultez les guides suivants: