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

Las guías de inicio rápido explican cómo configurar y ejecutar una app que llama a un API de Google Workspace.

Las guías de inicio rápido de Google Workspace usan las bibliotecas cliente de la API para controlar algunas los detalles del flujo de autenticación y autorización. Te recomendamos lo siguiente: usas las bibliotecas cliente para tus propias apps. En esta guía de inicio rápido, se usa un de autenticación simplificada que es adecuado para realizar pruebas en un entorno de nube. Para un entorno de producción, recomendamos conocer autenticación y autorización antes de elige las credenciales de acceso que sean adecuados para tu app.

Crear una aplicación de línea de comandos de Node.js que realice solicitudes a la API del SDK de Admin.

Objetivos

• Configurar 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.
• Un proyecto de Google Cloud.

• Un dominio de Google Workspace con 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 del SDK de Admin.

  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 has 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 apps y, luego, haz clic en Guardar y continuar.

4. Por ahora, puedes omitir el paso de 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 la aplicación el registro parece estar bien, haz clic en Volver al panel.

Autoriza credenciales para una aplicación de escritorio

Para autenticar usuarios finales y acceder a sus datos en tu app, debes hacer lo siguiente: 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 diferente para cada plataforma.

Precaución: Esta guía de inicio rápido debe ejecutarse de forma local y con acceso a un navegador. Integra 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 > Aplicación 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 de creación del cliente de OAuth, en la que se mostrará tu nuevo ID de cliente y secreto del cliente.
6. Haz clic en Aceptar. La credencial nueva aparece en ID de cliente de OAuth 2.0.
7. Guarda el archivo JSON descargado como credentials.json y mueve el a tu 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 el directorio de trabajo, crea un archivo llamado index.js.

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

   adminSDK/reports/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.reports.audit.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 last 10 login events for the domain.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listLoginEvents(auth) {
     const service = google.admin({version: 'reports_v1', auth});
     const res = await service.activities.list({
       userKey: 'all',
       applicationName: 'login',
       maxResults: 10,
     });
     const activities = res.data.items;
     if (!activities || activities.length === 0) {
       console.log('No logins found.');
       return;
     }
   
     console.log('Logins:');
     activities.forEach((activity) => {
       console.log(
           `${activity.id.time}: ${activity.actor.email} (${activity.events[0].name})`,
       );
     });
   }
   
   authorize().then(listLoginEvents).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 accediste a varias cuentas, selecciona una para usar la autorización.
   2. Haz clic en Aceptar.

   Tu aplicación de Nodejs se ejecuta y llama a la API del SDK de Admin.

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

Próximos pasos

• Soluciona problemas de autenticación y autorización
• Documentación de referencia de la API de informes del SDK de Admin
• Sección google-api-nodejs-client de GitHub