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

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

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

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

Цели

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

Предпосылки

• Проект Google Cloud .

• Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .

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

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

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

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

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

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

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

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

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

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

  Включить API

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

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

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

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

чат/быстрый старт/Code.gs

Посмотреть на GitHub

/**
 * 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);
}

3. Нажмите «Сохранить». .
4. Щелкните «Проект без названия» , введите «Быстрый старт» и щелкните «Переименовать» .

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

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

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

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

2. В поле Номер проекта скопируйте значение.

Свяжите свой проект Google Cloud

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

Включить API чата Google

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

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

chat/quickstart/appsscript.json

Посмотреть на GitHub

{
  "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"
    }]
  }
}

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

В редакторе скриптов приложений нажмите кнопку «Выполнить» .

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

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

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

! Сработало!

Отлично! Ознакомьтесь с разделом «Дополнительное чтение» ниже, чтобы узнать больше.

Возникла проблема

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

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

• Документация по расширенным службам Google Apps Script