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

Guide de démarrage rapide pour Node.js

Créez une application de ligne de commande Node.js qui envoie des requêtes à l'API Google Chat.

Les guides de démarrage rapide expliquent comment configurer et exécuter une application qui appelle une API Google Workspace. Ce guide de démarrage rapide utilise une approche d'authentification simplifiée qui convient à un environnement de test. Pour un environnement de production, nous vous recommandons de vous renseigner sur l'authentification et l'autorisation avant de choisir les identifiants d'accès adaptés à votre application.

Ce guide de démarrage rapide utilise les bibliothèques clientes d'API recommandées de Google Workspace pour gérer certains détails du flux d'authentification et d'autorisation.

Objectifs

configurer votre environnement ;
Installez la bibliothèque cliente.
Configurez l'échantillon.
Exécutez l'exemple.

Prérequis

Pour exécuter ce guide de démarrage rapide, vous devez remplir les conditions préalables suivantes :

Node.js et npm sont installés.
Un projet Google Cloud.

Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.

Configurer votre environnement

Pour suivre ce guide de démarrage rapide, configurez votre environnement.

Activer l'API

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

Configurer l'écran d'autorisation OAuth

Si vous utilisez un nouveau projet Google Cloud pour effectuer ce démarrage rapide, configurez l'écran d'autorisation OAuth. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.

Dans la console Google Cloud, accédez à Menu > > Branding.
Accéder à "Branding"
Si vous avez déjà configuré , 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 pas encore configuré s'affiche, cliquez sur Commencer :

Sous Informations sur l'application, dans Nom de l'application, saisissez le nom de l'application.
Dans Adresse e-mail d'assistance utilisateur, sélectionnez une adresse e-mail d'assistance que les utilisateurs pourront 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 l'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 de portées. À 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 le consentement OAuth.

Autoriser les identifiants pour une application de bureau

Pour authentifier les utilisateurs finaux et accéder aux données utilisateur dans votre application, vous devez créer un ou plusieurs ID client OAuth 2.0. Un ID client sert à identifier une application unique auprès des serveurs OAuth de Google. Si votre application s'exécute sur plusieurs plates-formes, vous devez créer un ID client distinct pour chacune d'elles.

Dans la console Google Cloud, accédez à Menu > > Clients.
Accéder à "Clients"
Cliquez sur Créer un client.
Cliquez sur Type d'application > Application de bureau.
Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
Cliquez sur Créer.
Les identifiants que vous venez de créer s'affichent sous "ID client OAuth 2.0".
Enregistrez le fichier JSON téléchargé sous le nom credentials.json, puis déplacez-le vers votre répertoire de travail.

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'UI à l'aide des informations suivantes.

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

Accéder à la page de configuration de l'API Chat
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.
Sous Fonctionnalités interactives, cliquez sur le bouton Activer les fonctionnalités interactives pour désactiver les fonctionnalités interactives de l'application Chat.
Cliquez sur Enregistrer.

Installer la bibliothèque cliente

Installez les bibliothèques à l'aide de npm :

npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save

Configurer l'exemple

Dans votre répertoire de travail, créez un fichier nommé index.js.

Dans le fichier, collez le code suivant :

chat/quickstart/index.js

Afficher sur GitHub

const fs = require('fs').promises;
const path = require('path');
const process = require('process');
const {authenticate} = require('@google-cloud/local-auth');
const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');

// If modifying these scopes, delete token.json.
const SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];

// The file token.json stores the user's access and refresh tokens, and is
// created automatically when the authorization flow completes for the first
// time.
const TOKEN_PATH = path.join(process.cwd(), 'token.json');
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Reads previously authorized credentials from the save file.
 *
 * @return {Promise<OAuth2Client|null>}
 */
async function loadSavedCredentialsIfExist() {
  try {
    const content = await fs.readFile(TOKEN_PATH);
    const credentials = JSON.parse(content);
    return auth.fromJSON(credentials);
  } catch (err) {
    console.log(err);
    return null;
  }
}

/**
 * Serializes credentials to a file compatible with GoogleAuth.fromJSON.
 *
 * @param {OAuth2Client} client
 * @return {Promise<void>}
 */
async function saveCredentials(client) {
  const content = await fs.readFile(CREDENTIALS_PATH);
  const keys = JSON.parse(content);
  const key = keys.installed || keys.web;
  const payload = JSON.stringify({
    type: 'authorized_user',
    client_id: key.client_id,
    client_secret: key.client_secret,
    refresh_token: client.credentials.refresh_token,
  });
  await fs.writeFile(TOKEN_PATH, payload);
}

/**
 * Load or request or authorization to call APIs.
 *
 * @return {Promise<OAuth2Client>}
 */
async function authorize() {
  let client = await loadSavedCredentialsIfExist();
  if (client) {
    return client;
  }
  client = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });
  if (client.credentials) {
    await saveCredentials(client);
  }
  return client;
}

/**
 * Lists spaces with user credential.
 * @param {OAuth2Client} authClient An authorized OAuth2 client.
 */
async function listSpaces(authClient) {
  // Create a client
  const chatClient = new ChatServiceClient({
    authClient: authClient,
    scopes: SCOPES,
  });

  // Initialize request argument(s)
  const request = {
    // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
    filter: 'space_type = "SPACE"'
  };

  // Make the request
  const pageResult = chatClient.listSpacesAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

authorize().then(listSpaces).catch(console.error);

Exécuter l'exemple

Dans votre répertoire de travail, exécutez l'exemple :
```
node .
```

La première fois que vous exécutez l'exemple, vous êtes invité à autoriser l'accès :
1. Si vous n'êtes pas encore connecté à votre compte Google, connectez-vous lorsque vous y êtes invité. Si vous êtes connecté à plusieurs comptes, sélectionnez-en un à utiliser pour l'autorisation.
2. Cliquez sur Accepter.
Votre application Node.js s'exécute et appelle l'API Google Chat.

Les informations d'autorisation sont stockées dans le système de fichiers. La prochaine fois que vous exécuterez l'exemple de code, vous ne serez pas invité à fournir une autorisation.

Étapes suivantes

Client de l'API Google Chat sur GitHub