Краткое руководство по сценариям Google Apps

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

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

Создайте скрипт Google Apps , который отправляет запросы к API Google Chat.

Цели

  • Настройте среду.
  • Создайте и настройте скрипт.
  • Запустите сценарий.

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

Настройте свой облачный проект

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

Откройте свой облачный проект в консоли Google Cloud.

Если он еще не открыт, откройте проект Cloud, который вы собираетесь использовать для этого примера:

  1. В консоли Google Cloud перейдите на страницу «Выбор проекта» .

    Выберите облачный проект

  2. Выберите проект Google Cloud, который вы хотите использовать. Или нажмите «Создать проект» и следуйте инструкциям на экране. Если вы создаете проект Google Cloud, вам может потребоваться включить для него оплату .

Включите API чата

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

    Перейдите на экран согласия OAuth.

  2. В качестве типа пользователя выберите «Внутренний» , затем нажмите « Создать» .
  3. Заполните форму регистрации приложения, затем нажмите «Сохранить и продолжить» .

  4. На данный момент вы можете пропустить добавление областей и нажать «Сохранить и продолжить» . В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вам необходимо изменить тип пользователя на Внешний , а затем добавить области авторизации, необходимые вашему приложению.

  5. Просмотрите сводку регистрации приложения. Чтобы внести изменения, нажмите «Изменить» . Если регистрация приложения выглядит нормально, нажмите «Вернуться на панель управления» .

Настройте приложение Google Chat

Чтобы вызвать API Google Chat, необходимо настроить приложение Google Chat. Для любых запросов на запись Google Chat атрибутирует приложение Google Chat в пользовательском интерфейсе, используя следующую информацию.

  1. В консоли Google Cloud перейдите на страницу конфигурации Chat API:

    Перейдите на страницу конфигурации API чата.

  2. В разделе «Информация о приложении» введите следующую информацию:

    1. В поле «Имя приложения» введите Chat API quickstart app .
    2. В поле URL-адрес аватара введите https://developers.google.com/chat/images/quickstart-app-avatar.png .
    3. В поле «Описание» введите Quickstart for calling the Chat API .

  3. В разделе «Интерактивные функции » установите переключатель « Включить интерактивные функции» в положение «Выкл.», чтобы отключить интерактивные функции для приложения Chat.

  4. Нажмите Сохранить .

Создать сценарий

  1. Создайте новый скрипт, перейдя по адресу script.google.com/create .
  2. Замените содержимое редактора скриптов следующим кодом:

чат/быстрый старт/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. Нажмите «Сохранить». .
  2. Нажмите «Проект без названия» , введите «Quickstart» и нажмите «Переименовать» .

Настроить скрипт

Скопируйте номер облачного проекта

  1. В консоли Google Cloud выберите > IAM и администрирование > Настройки .

    Перейдите в IAM и настройки администратора.

  2. В поле Номер проекта скопируйте значение.
  1. Откройте проект Apps Script.
  2. Нажмите параметров проекта» .
  3. В разделе «Проект Google Cloud Platform (GCP)» нажмите «Изменить проект» .
  4. В поле «Номер проекта GCP» вставьте номер проекта Google Cloud.
  5. Нажмите Установить проект .

Включите API Чата Google

  1. Откройте проект Apps Script.
  1. Нажмите параметров проекта» .
  2. В разделе «Общие настройки » включите « Показывать файл манифеста «appsscript.json» в редакторе» .
  3. Нажмите редактора» , выберите файл appscript.json и замените его содержимое следующим кодом:

чат/быстрый старт/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

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

В редакторе Apps Script нажмите «Выполнить» .

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

  1. Нажмите «Просмотреть разрешения» .
  2. Выберите учетную запись.
  3. Нажмите Разрешить .

Журнал выполнения скрипта отображается в нижней части окна.

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