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

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

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

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

Цели

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

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

Для запуска этого краткого руководства необходимы следующие предварительные условия:

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

• Аккаунт Google с включенными задачами Google.

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

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

Включить API

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

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

  Включить API

Настройка экрана согласия OAuth

Если для выполнения этого краткого руководства вы используете новый проект Google Cloud, настройте экран согласия OAuth. Если вы уже выполнили этот шаг для своего облачного проекта, перейдите к следующему разделу.

1. В консоли Google Cloud перейдите в Меню > > Брендинг .

   Перейти к Брендингу

2. Если вы уже настроили вы можете настроить следующие параметры экрана согласия OAuth в разделах «Брендинг» , «Аудитория» и «Доступ к данным» . Если вы видите сообщение, в котором говорится еще не настроено , нажмите «Начать» :
1. В разделе «Информация о приложении» в поле «Имя приложения» введите имя приложения.
2. В разделе «Электронная почта поддержки пользователей» выберите адрес электронной почты службы поддержки, по которому пользователи смогут связаться с вами, если у них возникнут вопросы относительно их согласия.
3. Нажмите Далее .
4. В разделе «Аудитория» выберите «Внутренняя» .
5. Нажмите Далее .
6. В разделе «Контактная информация » введите адрес электронной почты , по которому вас будут уведомлять о любых изменениях в вашем проекте.
7. Нажмите Далее .
8. В разделе «Готово » ознакомьтесь с Политикой использования данных пользователей служб API Google и, если вы согласны, выберите «Я согласен с политикой данных пользователей служб API Google» .
9. Нажмите Продолжить .
10. Нажмите Создать .
3. На данный момент вы можете пропустить добавление областей. В будущем, когда вы будете создавать приложение для использования за пределами вашей организации Google Workspace, вам необходимо будет изменить тип пользователя на Внешний . Затем добавьте области авторизации, необходимые вашему приложению. Дополнительные сведения см. в полном руководстве по настройке согласия OAuth .

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

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

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

1. В консоли Google Cloud перейдите в Меню > > Клиенты .

   Перейти к Клиентам

2. Нажмите Создать клиента .
3. Нажмите Тип приложения > Приложение для ПК .
4. В поле Имя введите имя учетных данных. Это имя отображается только в консоли Google Cloud.
5. Нажмите Создать .

   Вновь созданные учетные данные появятся в разделе «Идентификаторы клиентов OAuth 2.0».

6. Сохраните загруженный файл JSON как credentials.json и переместите его в свой рабочий каталог.

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

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

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

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

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

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

   задачи/быстрый старт/index.js

   Посмотреть на 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/tasks.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 user's first 10 task lists.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listTaskLists(auth) {
     const service = google.tasks({version: 'v1', auth});
     const res = await service.tasklists.list({
       maxResults: 10,
     });
     const taskLists = res.data.items;
     if (taskLists && taskLists.length) {
       console.log('Task lists:');
       taskLists.forEach((taskList) => {
         console.log(`${taskList.title} (${taskList.id})`);
       });
     } else {
       console.log('No task lists found.');
     }
   }
   
   authorize().then(listTaskLists).catch(console.error);

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

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

   node .
   

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

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

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

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

• Устранение проблем с аутентификацией и авторизацией
• Справочная документация по API задач
• раздел google-api-nodejs-client на GitHub