Node.js-Kurzanleitung

In den Kurzanleitungen wird erläutert, wie Sie eine Anwendung einrichten und ausführen, die eine Google Workspace API aufruft.

In Google Workspace-Kurzanleitungen werden einige Details des Authentifizierungs- und Autorisierungsvorgangs mithilfe der API-Clientbibliotheken verarbeitet. Wir empfehlen, die Clientbibliotheken für Ihre eigenen Anwendungen zu verwenden. In dieser Kurzanleitung wird ein vereinfachter Authentifizierungsansatz verwendet, der für eine Testumgebung geeignet ist. Für eine Produktionsumgebung sollten Sie sich über die Authentifizierung und Autorisierung informieren, bevor Sie die für Ihre Anwendung geeigneten Anmeldedaten auswählen.

Erstellen Sie eine Node.js-Befehlszeilenanwendung, die Anfragen an die Drive Labels API sendet.

Zielsetzungen

• die Umgebung einrichten
• Installieren Sie die Clientbibliothek.
• Richten Sie die Stichprobe ein.
• Führen Sie das Beispiel aus.

Voraussetzungen

• Node.js und npm installiert
• Ein Google Cloud-Projekt

• Ein Google-Konto.

Umgebung einrichten

Richten Sie Ihre Umgebung ein, um diese Kurzanleitung abzuschließen.

API aktivieren

Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.

• Aktivieren Sie in der Google Cloud Console die Drive Labels API.

  API aktivieren

Anmeldedaten für eine Desktopanwendung autorisieren

Um Endnutzer zu authentifizieren und auf Nutzerdaten in der Anwendung zuzugreifen, müssen Sie eine oder mehrere OAuth 2.0-Client-IDs erstellen. Eine Client-ID wird zur Identifizierung einer einzelnen Anwendung bei Googles OAuth-Servern verwendet. Wenn Ihre Anwendung auf mehreren Plattformen ausgeführt wird, müssen Sie für jede Plattform eine separate Client-ID erstellen.

Achtung: Diese Kurzanleitung muss lokal und mit Zugriff auf einen Browser ausgeführt werden. Er funktioniert nicht, wenn er auf einem Remote-Terminal wie Cloud Shell oder über SSH ausgeführt wird.

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > APIs und Dienste > Anmeldedaten.

   Zu den Anmeldedaten

2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
3. Klicken Sie auf Anwendungstyp > Desktop-App.
4. Geben Sie im Feld Name einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
5. Klicken Sie auf Erstellen. Der Bildschirm "OAuth-Client erstellt" wird mit Ihrer neuen Client-ID und Ihrem Clientschlüssel angezeigt.
6. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter OAuth 2.0-Client-IDs angezeigt.
7. Speichern Sie die heruntergeladene JSON-Datei als credentials.json und verschieben Sie die Datei in Ihr Arbeitsverzeichnis.

Clientbibliothek installieren

• Installieren Sie die Bibliotheken mit npm:

  npm install googleapis@113 @google-cloud/local-auth@2.1.1 --save
  

Beispielanwendung einrichten

1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen index.js.

2. Fügen Sie den folgenden Code in die Datei ein:

       const fs = require('fs');
       const readline = require('readline');
       const {google} = require('googleapis');
   
       // If modifying these scopes, delete token.json.
       const SCOPES = ['https://www.googleapis.com/auth/drive.labels.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 = 'token.json';
   
       // Load client secrets from a local file.
       fs.readFile('credentials.json', (err, content) => {
         if (err) return console.log('Error loading client secret file:', err);
         // Authorize a client with credentials, then call the Google Drive Labels
         // API.
         authorize(JSON.parse(content), listDriveLabels);
       });
   
       /**
       * Create an OAuth2 client with the given credentials, and then execute the
       * given callback function.
       * @param {Object} credentials The authorization client credentials.
       * @param {function} callback The callback to call with the authorized client.
       */
       function authorize(credentials, callback) {
         const {client_secret, client_id, redirect_uris} = credentials.installed;
         const oAuth2Client = new google.auth.OAuth2(
             client_id, client_secret, redirect_uris[0]);
   
         // Check if we have previously stored a token.
         fs.readFile(TOKEN_PATH, (err, token) => {
           if (err) return getNewToken(oAuth2Client, callback);
           oAuth2Client.setCredentials(JSON.parse(token));
           callback(oAuth2Client);
         });
       }
   
       /**
       * Get and store new token after prompting for user authorization, and then
       * execute the given callback with the authorized OAuth2 client.
       * @param {google.auth.OAuth2} oAuth2Client The OAuth2 client to get token for.
       * @param {getEventsCallback} callback The callback for the authorized client.
       */
       function getNewToken(oAuth2Client, callback) {
         const authUrl = oAuth2Client.generateAuthUrl({
           access_type: 'offline',
           scope: SCOPES,
         });
         console.log('Authorize this app by visiting this url:', authUrl);
         const rl = readline.createInterface({
           input: process.stdin,
           output: process.stdout,
         });
         rl.question('Enter the code from that page here: ', (code) => {
           rl.close();
           oAuth2Client.getToken(code, (err, token) => {
             if (err) return console.error('Error retrieving access token', err);
             oAuth2Client.setCredentials(token);
             // Store the token to disk for later program executions
             fs.writeFile(TOKEN_PATH, JSON.stringify(token), (err) => {
               if (err) return console.error(err);
               console.log('Token stored to', TOKEN_PATH);
             });
             callback(oAuth2Client);
           });
         });
       }
   
       function listDriveLabels(auth) {
         const service = google.drivelabels({version: 'v2', auth});
         const params = {
           'view': 'LABEL_VIEW_FULL'
         };
         service.labels.list(params, (err, res) => {
           if (err) return console.error('The API returned an error: ' + err);
           const labels = res.data.labels;
           if (labels) {
             labels.forEach((label) => {
               const name = label.name;
               const title = label.properties.title;
               console.log(`${name}\t${title}`);
             });
           } else {
             console.log('No Labels');
           }
         });
       }
   

Beispiel ausführen

1. Führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

   node .
   

2. Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:

   1. Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, werden Sie zur Anmeldung aufgefordert. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie ein Konto für die Autorisierung aus.
   2. Klicken Sie auf Accept.

   Die Autorisierungsinformationen werden im Dateisystem gespeichert, sodass Sie nicht zur Autorisierung aufgefordert werden, wenn Sie den Beispielcode das nächste Mal ausführen.

Sie haben Ihre erste Nodejs-Anwendung erstellt, die Anfragen an die Drive Labels API sendet.

Nächste Schritte

• Probleme bei der Authentifizierung und Autorisierung beheben
• Abschnitt zum Node.js-Client für Google APIs auf GitHub