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

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

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

В этом кратком руководстве используются рекомендуемые API-клиентские библиотеки Google Workspace для обработки некоторых деталей процесса аутентификации и авторизации.

Цели

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

Требования

Чтобы выполнить инструкции из этого руководства, вам потребуется:

Как настроить среду

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

Включение API

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

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

  1. В консоли API Google нажмите на значок меню > Платформа аутентификации Google > Брендинг.

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

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

Как авторизовать учетные данные для компьютерного приложения

Чтобы аутентифицировать конечных пользователей и получить доступ к их данным в приложении, создайте один или несколько идентификаторов клиента OAuth 2.0. Идентификатор клиента используется для идентификации одного приложения на серверах OAuth Google. Если ваше приложение работает на нескольких платформах, вам нужно создать отдельный идентификатор клиента для каждой из них.
  1. В консоли Google Cloud нажмите на значок меню > Google Auth platform (Платформа Google Auth) > Clients (Клиенты).

    Перейти в раздел "Клиенты"

  2. Нажмите Create Client (Создать клиента).
  3. Нажмите Тип приложения > Компьютерное приложение.
  4. В поле Название введите название учетных данных. Это название показывается только в консоли Google Cloud.
  5. Если ваше приложение – это ИИ-агент, который выполняет действия от имени пользователей, выберите Использовать этого клиента для ИИ-агента. Если ваше приложение поддерживает как рабочие процессы ИИ-агентов, так и стандартные функции для пользователей, создайте отдельные клиенты OAuth для каждого из них. После создания клиента изменить эту настройку нельзя.
  6. Нажмите Создать.

    Новые учетные данные появятся в разделе "Идентификаторы клиентов OAuth 2.0".

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

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

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

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

Настройка примера

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

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

    people/quickstart/index.js
    import path from 'node:path';
    import process from 'node:process';
    import {authenticate} from '@google-cloud/local-auth';
    import {google} from 'googleapis';
    
    // The scope for reading contacts.
    const SCOPES = ['https://www.googleapis.com/auth/contacts.readonly'];
    // The path to the credentials file.
    const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');
    
    /**
     * Prints the display names of the first 10 connections.
     */
    async function listConnectionNames() {
      // Authenticate with Google and get an authorized client.
      const auth = await authenticate({
        scopes: SCOPES,
        keyfilePath: CREDENTIALS_PATH,
      });
    
      // Create a new People API client.
      const service = google.people({version: 'v1', auth});
      // Get the list of connections.
      const result = await service.people.connections.list({
        resourceName: 'people/me',
        pageSize: 10,
        personFields: 'names,emailAddresses',
      });
      const connections = result.data.connections;
      if (!connections || connections.length === 0) {
        console.log('No connections found.');
        return;
      }
      console.log('Connections:');
      // Print the display name of each connection.
      connections.forEach((person) => {
        if (person.names && person.names.length > 0) {
          console.log(person.names[0].displayName);
        } else {
          console.log('No display name found for connection.');
        }
      });
    }
    
    await listConnectionNames();

Запустите пример

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

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

    Приложение Node.js запустится и вызовет People API.

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

Дальнейшие действия