Guide de démarrage rapide de Google Apps Script

Les guides de démarrage rapide expliquent comment configurer et exécuter une application qui appelle une API Google Workspace.

Les démarrages rapides Google Workspace utilisent les bibliothèques clientes de l'API pour gérer certains détails du flux d'authentification et d'autorisation. Nous vous recommandons d'utiliser les bibliothèques clientes pour vos propres applications. Ce guide de démarrage rapide utilise une approche d'authentification simplifiée adaptée à un environnement de test. Pour un environnement de production, nous vous recommandons de vous familiariser avec l'authentification et l'autorisation avant de choisir les identifiants d'accès appropriés pour votre application.

Créez un script Google Apps qui envoie des requêtes à l'API Google Chat.

Objectifs

  • Configurez l'environnement.
  • Créez et configurez le script.
  • Exécutez le script.

Prérequis

Configurer votre projet Cloud

Si vous utilisez un nouveau projet Google Cloud pour suivre ce guide de démarrage rapide, vous devez le configurer et vous ajouter en tant qu'utilisateur de test. Si vous avez déjà effectué ces étapes pour votre projet Cloud, passez à la section suivante.

Ouvrez votre projet Cloud dans la console Google Cloud.

Si ce n'est pas déjà fait, ouvrez le projet Cloud que vous prévoyez d'utiliser pour cet exemple:

  1. Dans la console Google Cloud, accédez à la page Sélectionner un projet.

    Sélectionner un projet Cloud

  2. 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.

Activer l'API Chat

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.

  • Dans la console Google Cloud, activez l'API Google Chat.

    Activer l'API

  1. Dans la console Google Cloud, accédez à Menu  > API et services > Écran de consentement OAuth.

    Accéder à l'écran de consentement OAuth

  2. Pour Type d'utilisateur, sélectionnez Interne, puis cliquez sur Créer.
  3. Remplissez le formulaire d'enregistrement de l'application, puis cliquez sur Enregistrer et continuer.

  4. 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 à utiliser en dehors de votre organisation Google Workspace, vous devrez remplacer le type d'utilisateur par Externe, puis ajouter les champs d'autorisation requis par votre application.

  5. Consultez le résumé de l'enregistrement de votre application. Pour y apporter des modifications, cliquez sur Modifier. Si l'enregistrement de l'application semble correct, cliquez sur Revenir au tableau de bord.

Configurer l'application Google Chat

Pour appeler l'API Google Chat, vous devez configurer une application Google Chat. Pour toutes les requêtes d'écriture, Google Chat attribue l'application Google Chat dans l'UI à l'aide des informations suivantes.

  1. Dans la console Google Cloud, accédez à la page Configuration de l'API Chat:

    Accéder à la page "Configuration de l'API Chat"

  2. Sous Application info (Informations sur l'application), saisissez les informations suivantes:

    1. Dans le champ Nom de l'application, saisissez Chat API quickstart app.
    2. Dans le champ Avatar URL (URL de l'avatar), saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. Dans le champ Description, saisissez Quickstart for calling the Chat API.

  3. Sous Fonctionnalités interactives, cliquez sur le bouton d'activation/de désactivation Activer les fonctionnalités interactives pour désactiver les fonctionnalités interactives de l'application Chat.

  4. Cliquez sur Enregistrer.

Créer le script

  1. Accédez à la page script.google.com/create pour créer un script.
  2. Remplacez le contenu de l'éditeur de scripts par le code suivant:

chat/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. Cliquez sur Enregistrer .
  2. Cliquez sur Projet sans titre, saisissez Premiers pas, puis cliquez sur Renommer.

Configurer le script

Copiez le numéro du projet Cloud

  1. Dans la console Google Cloud, accédez à Menu  > IAM et administration > Paramètres.

    Accéder à la page Paramètres de la section IAM et administration

  2. Dans le champ Numéro du projet, copiez la valeur.
  1. Ouvrez le projet Apps Script.
  2. Cliquez sur Paramètres du projet .
  3. Sous Projet Google Cloud Platform (GCP), cliquez sur Changer de projet.
  4. Dans Numéro de projet GCP, collez le numéro du projet Google Cloud.
  5. Cliquez sur Définir un projet.

Activer l'API Google Chat

  1. Ouvrez le projet Apps Script.
  1. Cliquez sur Paramètres du projet .
  2. Sous Paramètres généraux, activez l'option Afficher le fichier manifeste "appsscript.json" dans l'éditeur.
  3. Cliquez sur Éditeur , sélectionnez le fichier appscript.json et remplacez son contenu par le code suivant:

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

Exécuter l'exemple

Dans l'éditeur Apps Script, cliquez sur Exécuter.

La première fois que vous exécutez l'exemple, vous êtes invité à autoriser l'accès:

  1. Cliquez sur Examiner les autorisations.
  2. Choisissez un compte.
  3. Cliquez sur Autoriser.

Le journal d'exécution du script s'affiche en bas de la fenêtre.

Étapes suivantes