Guide de démarrage rapide de Google Apps Script

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

Les démarrages rapides expliquent comment configurer et exécuter une application qui appelle une API Google Workspace. Ce 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 adaptés à votre application.

Dans Apps Script, les démarrages rapides Google Workspace utilisent les services avancés Google pour appeler les API Google Workspace et gérer certains détails du flux d'authentification et d'autorisation.

Objectifs

  • Configurer l'environnement
  • Créer et configurer le script
  • Exécuter le script

Prérequis

Configurer votre projet Cloud

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

Ouvrir votre projet Cloud dans la console Google Cloud

Si ce n'est pas déjà fait, ouvrez le projet Cloud que vous comptez 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 APIs, accédez à Menu > Google Auth Platform > Branding.

    Accéder à la page "Branding"

  2. Si vous avez déjà configuré Google Auth Platform, vous pouvez configurer les paramètres de l'écran d'autorisation OAuth suivants dans Branding, Audience et Accès aux données. Si le message Google Auth Platform pas encore configuré s'affiche, cliquez sur Premiers pas :
    1. Sous Informations sur l'application, dans Nom de l'application, saisissez un nom pour l'application.
    2. Dans Adresse e-mail d'assistance utilisateur, choisissez une adresse e-mail d'assistance à laquelle les utilisateurs pourront vous contacter s'ils ont des questions sur leur consentement.
    3. Cliquez sur Suivant.
    4. Sous Audience, sélectionnez Interne.
    5. Cliquez sur Suivant.
    6. Sous Coordonnées, saisissez une adresse e-mail à laquelle vous recevrez des notifications en cas de modification de votre projet.
    7. Cliquez sur Suivant.
    8. Sous Terminer, consultez le Règlement sur les données utilisateur dans les services d'API Google et, si vous l'acceptez, sélectionnez J'accepte le Règlement sur les données utilisateur dans les services d'API Google.
    9. Cliquez sur Continuer.
    10. Cliquez sur Créer.
  3. Pour l'instant, vous pouvez ignorer l'ajout de niveaux d'accès. À 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 niveaux d'autorisation dont votre application a besoin. Pour en savoir plus, consultez le guide complet Configurer l'écran de consentement OAuth guide.

Configurer l'application Google Chat

Pour appeler l'API Google Chat, vous devez configurer une application Google Chat. Pour toute requête d'écriture, Google Chat attribue l'application Google Chat dans l'interface utilisateur à l'aide des informations suivantes.

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

    Accéder à la page de configuration de l'API Chat

  2. Sous 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 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 Activer les fonctionnalités interactives pour le désactiver et désactiver ainsi les fonctionnalités interactives de l'application Chat.

  4. Cliquez sur Enregistrer.

Créer le script

  1. Créez un script dans l'éditeur Apps Script en accédant à script.google.com/create.
  2. Remplacez le contenu de l'éditeur de script 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) {
      for (const space of responsePage.spaces) {
        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 Démarrage rapide, puis cliquez sur Renommer.

Configurer le script

Copier le numéro du projet Cloud

  1. Dans la console Google APIs, 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

Ouvrez le projet Apps Script.

  1. Cliquez sur Paramètres du projet .
  2. Sous Paramètres généraux, activez Afficher le fichier manifeste "appsscript.json" dans l'éditeur.
  3. Cliquez sur Éditeur , sélectionnez le fichier appscript.json, puis 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