Guida rapida per Node.js

Le guide rapide spiegano come configurare ed eseguire un'app che chiama un'API Google Workspace.

Le guide rapide di Google Workspace utilizzano le librerie client delle API per gestire alcuni dettagli del flusso di autenticazione e autorizzazione. Ti consigliamo di utilizzare le librerie client per le tue app. Questa guida rapida utilizza un approccio di autenticazione semplificato appropriato per un ambiente di test. Per un ambiente di produzione, ti consigliamo di informarti su autenticazione e autorizzazione prima di scegliere le credenziali di accesso appropriate per la tua app.

Creare un'applicazione a riga di comando Node.js che invia richieste all'API Admin SDK.

Obiettivi

  • Configurare l'ambiente.
  • Installare la libreria client.
  • Configura il campione.
  • Esegui l'esempio.

Prerequisiti

Per eseguire questa guida rapida, devi disporre dei seguenti prerequisiti:

  • Un dominio Google Workspace con accesso API abilitato.
  • Un Account Google in quel dominio con privilegi amministrativi.

configura l'ambiente

Per completare questa guida rapida, configura il tuo ambiente.

Abilita l'API

Prima di utilizzare le API di Google, devi attivarle in un progetto Google Cloud. Puoi attivare una o più API in un singolo progetto Google Cloud.
  • Nella console Google Cloud, abilita l'API SDK Admin.

    Abilita l'API

Se utilizzi un nuovo progetto Google Cloud per completare questa guida rapida, configura la schermata per il consenso OAuth e aggiungiti come utente di test. Se hai già completato questo passaggio per il tuo progetto Cloud, vai alla sezione successiva.

  1. Nella console Google Cloud, vai a Menu > API e servizi > Schermata consenso OAuth.

    Vai alla schermata per il consenso OAuth

  2. Seleziona il tipo di utente per l'app e fai clic su Crea.
  3. Compila il modulo di registrazione dell'app, poi fai clic su Salva e continua.
  4. Per il momento, puoi saltare l'aggiunta di ambiti e fare clic su Salva e continua. In futuro, quando creerai un'app da utilizzare al di fuori della tua organizzazione Google Workspace, dovrai aggiungere e verificare gli ambiti di autorizzazione richiesti dall'app.

  5. Se hai selezionato Esterno come tipo di utente, aggiungi gli utenti di test:
    1. In Utenti di test, fai clic su Aggiungi utenti.
    2. Inserisci il tuo indirizzo email e tutti gli altri utenti di test autorizzati, quindi fai clic su Salva e continua.
  6. Rivedi il riepilogo della registrazione dell'app. Per apportare modifiche, fai clic su Modifica. Se la registrazione dell'app è corretta, fai clic su Torna alla dashboard.

Autorizza le credenziali per un'applicazione desktop

Per autenticare gli utenti finali e accedere ai dati utente nella tua app, devi creare uno o più ID client OAuth 2.0. Un ID client viene utilizzato per identificare una singola app nei server OAuth di Google. Se l'app viene eseguita su più piattaforme, devi creare un ID client separato per ogni piattaforma.
  1. Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.

    Vai a Credenziali

  2. Fai clic su Crea credenziali > ID client OAuth.
  3. Fai clic su Tipo di applicazione > App desktop.
  4. Nel campo Nome, digita un nome per la credenziale. Questo nome viene visualizzato solo nella console Google Cloud.
  5. Fai clic su Crea. Viene visualizzata la schermata Creazione del client OAuth, in cui sono indicati il nuovo ID client e il client secret.
  6. Fai clic su Ok. La credenziale appena creata viene visualizzata in ID client OAuth 2.0.
  7. Salva il file JSON scaricato come credentials.json e spostalo nella directory di lavoro.

installa la libreria client

  • Installa le librerie utilizzando npm:

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

Configura il Sample

  1. Nella directory di lavoro, crea un file denominato index.js.

  2. Nel file, incolla il seguente codice:

    adminSDK/reports/index.js
    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);

esegui l'esempio

  1. Nella tua directory di lavoro, esegui l'esempio:

    node .
    
  1. La prima volta che esegui l'esempio, ti viene richiesto di autorizzare l'accesso:
    1. Se non hai ancora eseguito l'accesso al tuo Account Google, accedi quando ti viene richiesto. Se hai eseguito l'accesso a più account, selezionane uno da utilizzare per l'autorizzazione.
    2. Fai clic su Accept (accetta).

    L'applicazione Nodejs viene eseguita e chiama l'API SDK Admin.

    Le informazioni sull'autorizzazione sono archiviate nel file system, pertanto, la prossima volta che esegui il codice di esempio, non viene richiesta l'autorizzazione.

Passaggi successivi