Краткое руководство по Node.js

В кратких руководствах объясняется, как настроить и запустить приложение, вызывающее API Google Workspace.

В кратких руководствах по Google Workspace клиентские библиотеки API используются для обработки некоторых деталей процесса аутентификации и авторизации. Мы рекомендуем вам использовать клиентские библиотеки для ваших собственных приложений. В этом кратком руководстве используется упрощенный подход к аутентификации, подходящий для среды тестирования. В производственной среде мы рекомендуем изучить аутентификацию и авторизацию, прежде чем выбирать учетные данные доступа , подходящие для вашего приложения.

Создайте приложение командной строки Node.js, которое отправляет запросы к API меток диска.

Цели

• Настройте свою среду.
• Установите клиентскую библиотеку.
• Настройте образец.
• Запустите образец.

Предварительные условия

• Node.js и npm установлены.
• Проект Google Cloud .

• Аккаунт Google.

Настройте свою среду

Чтобы завершить это краткое руководство, настройте свою среду.

Включить API

Прежде чем использовать API Google, вам необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.

• В консоли Google Cloud включите API меток диска.

  Включить API

Авторизация учетных данных для настольного приложения

Чтобы аутентифицировать конечных пользователей и получить доступ к пользовательским данным в вашем приложении, вам необходимо создать один или несколько идентификаторов клиентов OAuth 2.0. Идентификатор клиента используется для идентификации одного приложения на серверах Google OAuth. Если ваше приложение работает на нескольких платформах, вам необходимо создать отдельный идентификатор клиента для каждой платформы.

Внимание! Это краткое руководство необходимо запускать локально и с доступом к браузеру. Он не работает при запуске на удаленном терминале, таком как Cloud Shell, или через SSH.

1. В консоли Google Cloud выберите > API и службы > Учетные данные .

   Перейти к учетным данным

2. Нажмите «Создать учетные данные» > «Идентификатор клиента OAuth» .
3. Нажмите Тип приложения > Приложение для ПК .
4. В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
5. Нажмите Создать . Появится экран создания клиента OAuth, показывающий ваш новый идентификатор клиента и секрет клиента.
6. Нажмите ОК . Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».
7. Сохраните загруженный файл JSON как credentials.json и переместите его в свой рабочий каталог.

Установите клиентскую библиотеку

• Установите библиотеки с помощью npm:

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

Настройка образца

1. В своем рабочем каталоге создайте файл с именем index.js .

2. В файл вставьте следующий код:

       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');
           }
         });
       }
   

Запустите образец

1. В своем рабочем каталоге запустите образец:

   node .
   

2. При первом запуске примера вам будет предложено авторизовать доступ:

   1. Если вы еще не вошли в свою учетную запись Google, вам будет предложено войти в нее. Если вы вошли в несколько учетных записей, выберите одну учетную запись, которая будет использоваться для авторизации.
   2. Нажмите Принять .

   Информация об авторизации хранится в файловой системе, поэтому при следующем запуске примера кода вам не будет предложено авторизоваться.

Вы успешно создали свое первое приложение Nodejs, которое отправляет запросы к API меток дисков.

Следующие шаги

• Устранение проблем с аутентификацией и авторизацией
• Раздел Google API Node.js Client на GitHub .