Guía de inicio rápido de Node.js

En los guías de inicio rápido, se explica cómo configurar y ejecutar una app que llama a una API de Google Workspace.

Las guías de inicio rápido de Google Workspace usan las bibliotecas cliente de la API para controlar algunos detalles del flujo de autenticación y autorización. Te recomendamos que uses las bibliotecas cliente para tus propias apps. En esta guía de inicio rápido, se usa un enfoque de autenticación simplificado que es adecuado para un entorno de prueba. En el caso de un entorno de producción, te recomendamos que aprendas sobre la autenticación y autorización antes de elegir las credenciales de acceso adecuadas para tu app.

Crea una aplicación de línea de comandos de Node.js que realice solicitudes a la API de Directory.

Objetivos

• Configura el entorno.
• Instalar la biblioteca cliente.
• Configura la muestra.
• Ejecuta la muestra.

Requisitos previos

Para ejecutar esta guía de inicio rápido, necesitas los siguientes requisitos previos:

• Node.js y npm instalados
• Un proyecto de Google Cloud.

• Un dominio de Google Workspace con el acceso a la API habilitado
• Una Cuenta de Google en ese dominio con privilegios de administrador

Configura tu entorno

Para completar esta guía de inicio rápido, configura tu entorno.

Habilita la API

Antes de usar las APIs de Google, debes activarlas en un proyecto de Google Cloud. Puedes activar una o más APIs en un solo proyecto de Google Cloud.

• En la consola de Google Cloud, habilita la API de Directory.

  Habilitar la API

Cómo configurar la pantalla de consentimiento de OAuth

Si usas un proyecto de Google Cloud nuevo para completar esta guía de inicio rápido, configura la pantalla de consentimiento de OAuth y agrégate como usuario de prueba. Si ya completaste este paso para tu proyecto de Cloud, ve a la siguiente sección.

1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Pantalla de consentimiento de OAuth.

   Ir a la pantalla de consentimiento de OAuth

2. En Tipo de usuario, selecciona Interno y, luego, haz clic en Crear.
3. Completa el formulario de registro de la aplicación y, luego, haz clic en Guardar y continuar.

4. Por ahora, puedes omitir agregar permisos y hacer clic en Guardar y continuar. En el futuro, cuando crees una app para usarla fuera de tu organización de Google Workspace, debes cambiar el Tipo de usuario a Externo y, luego, agregar los permisos de autorización que requiere tu app.

5. Revisa el resumen del registro de tu app. Para realizar cambios, haz clic en Editar. Si el registro de la app parece correcto, haz clic en Volver al panel.

Cómo autorizar credenciales para una aplicación de escritorio

Para autenticar a los usuarios finales y acceder a sus datos en tu app, debes crear uno o más IDs de cliente de OAuth 2.0. Un ID de cliente se usa con el fin de identificar una sola app para los servidores de OAuth de Google. Si tu app se ejecuta en varias plataformas, debes crear un ID de cliente independiente para cada una.

Precaución: Esta guía de inicio rápido se debe ejecutar de forma local y con acceso a un navegador. No funciona si se ejecuta en una terminal remota, como Cloud Shell o a través de SSH.

1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Credenciales.

   Ir a Credenciales

2. Haz clic en Crear credenciales > ID de cliente de OAuth.
3. Haz clic en Tipo de aplicación > App para computadoras.
4. En el campo Nombre, escribe un nombre para la credencial. Este nombre solo se muestra en la consola de Google Cloud.
5. Haz clic en Crear. Aparecerá la pantalla Se creó el cliente de OAuth, que muestra tu nuevo ID de cliente y secreto de cliente.
6. Haz clic en Aceptar. La credencial recién creada aparecerá en IDs de cliente de OAuth 2.0.
7. Guarda el archivo JSON descargado como credentials.json y muévelo al directorio de trabajo.

Instala la biblioteca cliente

• Instala las bibliotecas con npm:

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

Configura la muestra

1. En tu directorio de trabajo, crea un archivo llamado index.js.

2. En el archivo, pega el siguiente código:

   adminSDK/directory/index.js

   Ver en 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/admin.directory.user'];
   // 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 users in the domain.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listUsers(auth) {
     const service = google.admin({version: 'directory_v1', auth});
     const res = await service.users.list({
       customer: 'my_customer',
       maxResults: 10,
       orderBy: 'email',
     });
   
     const users = res.data.users;
     if (!users || users.length === 0) {
       console.log('No users found.');
       return;
     }
   
     console.log('Users:');
     users.forEach((user) => {
       console.log(`${user.primaryEmail} (${user.name.fullName})`);
     });
   }
   
   authorize().then(listUsers).catch(console.error);

Ejecuta la muestra

1. En tu directorio de trabajo, ejecuta la muestra:

   node .
   

2. La primera vez que ejecutes la muestra, se te solicitará que autorices el acceso:
   1. Si aún no accediste a tu Cuenta de Google, hazlo cuando se te solicite. Si accedeste a varias cuentas, selecciona una para usarla en la autorización.
   2. Haz clic en Aceptar.

   Tu aplicación de Nodejs se ejecuta y llama a la API de Directory.

   La información de autorización se almacena en el sistema de archivos, por lo que la próxima vez que ejecutes el código de muestra, no se te solicitará autorización.

Próximos pasos

• Cómo solucionar problemas de autenticación y autorización
• Guías para desarrolladores de la API de Directory
• Documentación de referencia de la API de Directory
• Sección google-api-nodejs-client de GitHub