Guide de démarrage rapide pour Node.js

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 une application de ligne de commande Node.js qui envoie des requêtes à l'API Google Classroom.

Objectifs

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

Prérequis

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

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

• Un compte Google for Education avec Google Classroom activé

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

  Activer l'API

Configurer l'écran d'autorisation OAuth

Si vous utilisez un nouveau projet Google Cloud pour suivre cet atelier Qwik Start, configurez l'écran de consentement OAuth et ajoutez-vous en tant qu'utilisateur test. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.

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.

Autoriser des 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.

Attention :Cette procédure de démarrage rapide doit être exécutée en local et avec un accès à un navigateur. Il ne fonctionne pas si vous l'exécutez sur un terminal distant tel que Cloud Shell ou via SSH.

1. Dans la console Google Cloud, accédez à Menu  > API et services > Identifiants.

   Accéder à "Identifiants"

2. Cliquez sur Créer des identifiants > ID client OAuth.
3. Cliquez sur Type d'application > Application de bureau.
4. Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
5. Cliquez sur Créer. L'écran "Client OAuth créé" s'affiche, avec votre nouvel ID client et votre nouveau code secret.
6. Cliquez sur OK. Les identifiants nouvellement créés s'affichent sous ID client OAuth 2.0.
7. Enregistrez le fichier JSON téléchargé sous le nom credentials.json, puis déplacez-le dans votre répertoire de travail.

Installer la bibliothèque cliente

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

  npm install googleapis@95 @google-cloud/local-auth@2.1.0 --save
  

Configurer l'exemple

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

2. Dans le fichier, collez le code suivant:

   classroom/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 {google} = require('googleapis');
   
   // If modifying these scopes, delete token.json.
   const SCOPES = ['https://www.googleapis.com/auth/classroom.courses.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 google.auth.fromJSON(credentials);
     } catch (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.
    *
    */
   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 the first 10 courses the user has access to.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listCourses(auth) {
     const classroom = google.classroom({version: 'v1', auth});
     const res = await classroom.courses.list({
       pageSize: 10,
     });
     const courses = res.data.courses;
     if (!courses || courses.length === 0) {
       console.log('No courses found.');
       return;
     }
     console.log('Courses:');
     courses.forEach((course) => {
       console.log(`${course.name} (${course.id})`);
     });
   }
   
   authorize().then(listCourses).catch(console.error);

Exécuter l'exemple

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

   node .
   

2. 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 pour l'autorisation.
   2. Cliquez sur Accepter.

   Votre application Node.js s'exécute et appelle l'API Google Classroom.

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

Étapes suivantes

• Résoudre les problèmes d'authentification et d'autorisation
• Documentation de référence de l'API Classroom
• Section google-api-nodejs-client de GitHub