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

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

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

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

Цели

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

Предпосылки

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. В консоли Google Cloud перейдите на страницу конфигурации 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. В разделе «Интерактивные функции» переведите переключатель «Включить интерактивные функции» в положение «Выкл.», чтобы отключить интерактивные функции для приложения «Чат».

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

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

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

chat/quickstart/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. Щелкните «Проект без названия» , введите «Быстрый старт» и щелкните «Переименовать» .

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

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

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

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

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

Включить API Google Chat

Откройте проект Apps Script.

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

chat/quickstart/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. Нажмите Разрешить .

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

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