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

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

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

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

Цели

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

Требования

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

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

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

Включение API

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

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

  1. В Google API Console нажмите на значок меню > Google Auth platform (Платформа Google Auth) > Branding (Брендинг).

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

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

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

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

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

  2. Нажмите Создать клиента.
  3. Нажмите Тип приложения > Компьютерное приложение.
  4. В поле Name (Название) введите название учетных данных. Это название показывается только в консоли 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. Вставьте в файл следующий код:

    adminSDK/directory/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 the Admin SDK Directory API.
const SCOPES = ['https://www.googleapis.com/auth/admin.directory.user'];
// The path to the credentials file.
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Lists the first 10 users in the domain.
 */
async function listUsers() {
  // Authenticate with Google and get an authorized client.
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  // Create a new Admin SDK Directory API client.
  const service = google.admin({version: 'directory_v1', auth});
  // Get the list of users.
  const result = await service.users.list({
    customer: 'my_customer',
    maxResults: 10,
    orderBy: 'email',
  });

  const users = result.data.users;
  if (!users || users.length === 0) {
    console.log('No users found.');
    return;
  }

  // Print the primary email and full name of each user.
  console.log('Users:');
  users.forEach((user) => {
    console.log(`${user.primaryEmail} (${user.name?.fullName})`);
  });
}

await listUsers();

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

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

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

    Ваше приложение Node.js работает и вызывает Directory API.

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

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