Как создать приложение для Google Chat с помощью Google Apps Script

На этой странице рассказывается, как создать приложение Google Chat с помощью Google Apps Script. Приложение Chat позволяет отправлять сообщения напрямую и отвечает, повторяя их.

На диаграмме ниже показана архитектура и шаблон обмена сообщениями.

На приведенной выше схеме показано, как пользователь взаимодействует с приложением Chat, созданным с помощью Apps Script. Информация передается следующим образом:

1. Пользователь отправляет сообщение приложению Chat в чате или чат-группе.
2. Логика приложения Chat, реализованная в Apps Script, который находится в Google Cloud, получает и обрабатывает сообщение.
3. При необходимости логику приложения Chat можно интегрировать с сервисами Google Workspace, такими как Календарь или Таблицы, или другими сервисами Google, например Картами или YouTube.
4. Логика приложения Chat отправляет ответ обратно в сервис приложения Chat в Chat.
5. Ответ будет отправлен пользователю.

Цели

• Настройте среду.
• Настройте скрипт.
• Настройте приложение Chat.
• Проверьте приложение Chat.

Требования

• Аккаунт Google Workspace версии Business или Enterprise с доступом к Google Chat.
• Проект Google Cloud. Чтобы создать его, см. статью Как создать облачный проект Google Cloud.

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

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

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

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

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

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

Как включить Chat API

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

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

  Включите API

Как настроить окно запроса доступа OAuth

Для всех приложений, использующих OAuth 2.0, требуется настроить окно запроса доступа. Настройте окно запроса доступа OAuth для своего приложения. Это позволит вам определить, что будет показываться пользователям и проверяющим, а также зарегистрировать приложение, чтобы опубликовать его позже.

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

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

2. Если вы уже настроили платформу аутентификации Google, вы можете задать следующие настройки окна запроса доступа 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…

Как настроить скрипт

Чтобы настроить скрипт, используйте шаблон приложения Chat на странице Начало работы в Apps Script.

Как создать проект Apps Script

1. На странице Начало работы Apps Script перейдите к разделу Стартовые наборы дополнений Google Workspace и нажмите на шаблон Приложение Chat:

   Открыть шаблон приложения Chat

2. В новом проекте Apps Script, который откроется, задайте имя проекта:

   1. Нажмите Проект без названия.

   2. В поле Название проекта введите Quickstart app.

   3. Нажмите Переименовать.

В будущем, если вы захотите использовать определенные API Google или опубликовать приложение, вам нужно будет связать облачный проект с проектом Apps Script. В этом руководстве вам не нужно этого делать. Подробнее о проектах Google Cloud…

Как создать тестовое развертывание

Вам понадобится идентификатор развертывания для этого проекта Apps Script, чтобы использовать его на следующем шаге.

Чтобы получить идентификатор развертывания HEAD, выполните следующие действия:

1. В проекте Apps Script для приложения Chat нажмите Развернуть > Тестовые развертывания.
2. Скопируйте идентификатор развертывания головного устройства, чтобы использовать его на следующем шаге, и нажмите Готово.

Как настроить приложение Chat

Чтобы настроить приложение Google Chat, выполните следующие действия:

1. В API Console найдите Google Chat API и нажмите Google Chat API.
2. Нажмите Настроить.

3. Нажмите Настройки и настройте приложение Chat:

   1. В поле Название приложения введите Quickstart app.
   2. В поле Avatar URL (URL аватара) введите https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
   3. В поле Description (Описание) введите Quickstart app.
   4. В разделе Функциональность выберите Присоединяться к чат-группам и групповым чатам.
   5. В разделе Настройки подключения выберите Проект Apps Script.
   6. В поле Deployment ID (Идентификатор развертывания) вставьте идентификатор развертывания Head, скопированный ранее.
   7. В разделе Видимость выберите Определенные пользователи и группы в вашем домене и введите свой адрес электронной почты.

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

Приложение Chat готово отвечать на сообщения.

Как протестировать приложение Chat

Чтобы протестировать приложение Chat, откройте прямую переписку с ним и отправьте сообщение:

1. Откройте Google Chat, используя аккаунт Google Workspace, который вы указали, когда добавляли себя в качестве доверенного тестировщика.

   Перейти в Google Chat

2. Нажмите add Новый чат.
3. В поле Добавьте одного или нескольких пользователей введите название приложения Chat.

4. Выберите приложение Chat в результатах поиска. Откроется прямая переписка.

5. В новой прямой переписке с приложением введите Hello и нажмите enter.

   Приложение Chat поблагодарит вас за добавление и повторит ваше сообщение.

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

Устранение неполадок

Если приложение Google Chat или карточка возвращает ошибку, в интерфейсе Chat появляется сообщение "Что-то пошло не так". или "Не удалось обработать запрос". Иногда в интерфейсе Chat не показывается сообщение об ошибке, но приложение Chat или карточка выдает неожиданный результат, например не появляется сообщение на карточке.

Хотя в интерфейсе Chat может не показываться сообщение об ошибке, при включенном ведении журнала ошибок для приложений Chat вам будут доступны подробные сообщения об ошибках и данные журнала, которые помогут устранить неполадки. Чтобы узнать, как просматривать, отлаживать и исправлять ошибки, ознакомьтесь с разделом Устранение неполадок в Google Chat.

Организовать

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

1. В Google API Console перейдите на страницу Управление ресурсами. Нажмите Меню menu > IAM и администрирование > Управление ресурсами.

   Перейти в Менеджер ресурсов

2. В списке проектов выберите проект, который хотите удалить, и нажмите Удалить delete.
3. В диалоговом окне введите идентификатор проекта и нажмите Закрыть, чтобы удалить проект.

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

• Создание интерактивных карточек. Сообщения-карточки поддерживают определенную разметку, интерактивные элементы интерфейса, такие как кнопки, и мультимедийные объекты, например изображения. Используйте сообщения на карточках, чтобы предоставлять подробную информацию, собирать данные от пользователей и направлять их к следующему шагу.
• Отвечать на команды. Команды помогают пользователям находить и использовать основные функции вашего приложения Chat.
• Запуск диалоговых окон. Диалоговые окна представляют собой интерфейсы на основе карточек, которые приложение может открывать для взаимодействия с пользователем. Несколько карточек можно объединить в последовательность, чтобы помочь пользователям выполнить многоэтапные действия, например заполнить форму.
• code Практическая работа. Хотите создать более продвинутое приложение для чата? Посмотрите приложение для обратной связи из лабораторной работы Создание приложений для Google Chat с помощью Gemini.