На этой странице объясняется, как создать надстройку Google Workspace, которая будет работать в Google Chat, с помощью скрипта Google Apps. В Google Chat дополнения отображаются пользователям как приложения Google Chat. Дополнительную информацию см. в обзоре расширения Google Chat .
Приложение «Чат» позволяет вам напрямую отправлять сообщения и отвечать, повторяя ваши сообщения.
На следующей диаграмме показаны архитектура и шаблон обмена сообщениями:
На предыдущей диаграмме пользователь, взаимодействующий с приложением Apps Script Chat, имеет следующий поток информации:
- Пользователь отправляет сообщение в приложение чата либо в прямом сообщении, либо в чат-группе.
- Логика приложения Chat, реализованная в Apps Script, расположенном в Google Cloud, получает и обрабатывает сообщение.
- При желании логику приложения Chat можно интегрировать со службами Google Workspace, такими как Календарь или Таблицы, или другими службами Google, такими как Карты Google или YouTube.
- Логика приложения Chat отправляет ответ обратно в службу приложения Chat в Chat.
- Ответ доставляется пользователю.
Цели
- Настройте свою среду.
- Настройте сценарий.
- Настройте надстройку Google Workspace для приложения Chat.
- Протестируйте приложение Чат.
Предварительные условия
- Аккаунт Google Workspace для бизнеса или предприятия с доступом к Google Chat .
- Проект Google Cloud. Чтобы его создать, см. раздел Создание проекта Google Cloud .
Настройте свою среду
Откройте свой облачный проект в консоли Google Cloud.
Если он еще не открыт, откройте проект Cloud, который вы собираетесь использовать для этого примера:
- В консоли Google Cloud перейдите на страницу «Выбор проекта» .
- Выберите проект Google Cloud, который вы хотите использовать. Или нажмите «Создать проект» и следуйте инструкциям на экране. Если вы создаете проект Google Cloud, вам может потребоваться включить для него оплату .
Включите API чата
Прежде чем использовать API Google, вам необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.В консоли Google Cloud включите API Google Chat.
Настройка экрана согласия OAuth
Все приложения, использующие OAuth 2.0, требуют настройки экрана согласия. Настройка экрана согласия OAuth вашего приложения определяет, что будет отображаться пользователям и рецензентам приложения, а также регистрирует ваше приложение, чтобы вы могли опубликовать его позже.
- В консоли Google Cloud выберите > API и службы > Экран согласия OAuth .
- В качестве типа пользователя выберите «Внутренний» , затем нажмите « Создать» .
- Заполните форму регистрации приложения, затем нажмите «Сохранить и продолжить» .
На данный момент вы можете пропустить добавление областей и нажать «Сохранить и продолжить» . В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вам необходимо изменить тип пользователя на Внешний , а затем добавить области авторизации, необходимые вашему приложению.
- Просмотрите сводку регистрации приложения. Чтобы внести изменения, нажмите «Изменить» . Если регистрация приложения выглядит нормально, нажмите «Вернуться на панель управления» .
Настройте сценарий
Чтобы настроить скрипт, вы делаете копию проекта быстрого запуска, а затем устанавливаете свой облачный проект в Apps Script.
Создайте копию проекта быстрого запуска.
- Нажмите следующую кнопку, чтобы открыть надстройку в проекте скрипта Google Chat Apps.
Открыть проект - Нажмите Обзор .
- На странице обзора нажмите Сделайте копию .
Назовите свою копию проекта Apps Script:
Нажмите «Копия дополнительного приложения чата» .
В названии проекта введите
Add-on Chat app
Нажмите «Переименовать» .
Скопируйте номер облачного проекта
- В консоли Google Cloud выберите > IAM и администрирование > Настройки .
- В поле Номер проекта скопируйте значение.
Установите облачный проект проекта Apps Script.
- В проекте Apps Script приложения Chat нажмите «Настройки проекта». .
- В разделе «Проект Google Cloud Platform (GCP)» нажмите «Изменить проект» .
- В поле «Номер проекта GCP» вставьте номер проекта Google Cloud.
- Нажмите Установить проект .
Теперь у вас есть рабочий код приложения, который вы можете опробовать (как описано в следующих шагах), а затем настроить в соответствии со своими требованиями.
Перед открытием проекта Apps Script убедитесь, что вы вошли в правильную учетную запись Google. Текущая учетная запись иногда может незаметно для вас переключиться на учетную запись по умолчанию.
Создайте тестовое развертывание
Вам понадобится идентификатор развертывания для этого проекта Apps Script, чтобы вы могли использовать его на следующем шаге.
Чтобы получить идентификатор главного развертывания, выполните следующие действия:
- В проекте сценария приложений приложения Chat щелкните Развертывание > Тестовые развертывания .
- Скопируйте идентификатор развертывания Head для использования на следующем этапе и нажмите «Готово» .
Настроить дополнение
Используя развертывание Apps Script, выполните следующие действия, чтобы создать надстройку и развернуть приложение Google Chat:
- В консоли найдите
Google Chat API
и нажмите Google Chat API . - Нажмите «Управление» .
Нажмите «Конфигурация» и настройте приложение «Чат»:
- В поле «Название приложения» введите
Add-on Chat app
. - В поле URL-адрес аватара введите
https://developers.google.com/chat/images/quickstart-app-avatar.png
. - В поле «Описание» введите
Add-on Chat app
. - В разделе «Функциональность» выберите «Получать сообщения 1:1» и «Присоединяться к группам и групповым беседам» .
- В разделе «Настройки подключения» выберите «Проект Apps Script» .
- В поле «Идентификатор развертывания» вставьте идентификатор главного развертывания, который вы ранее скопировали.
- В разделе «Видимость» выберите «Определенные люди и группы в вашем домене» и введите свой адрес электронной почты.
- В поле «Название приложения» введите
Нажмите Сохранить .
Приложение Чат готово отвечать на сообщения.
Протестируйте приложение Чат
Чтобы протестировать приложение Chat, откройте пространство для прямых сообщений в приложении Chat и отправьте сообщение:
Откройте Google Chat, используя учетную запись Google Workspace, которую вы указали при добавлении себя в качестве доверенного тестировщика.
- Нажмите новый чат» .
- В поле «Добавить 1 или несколько человек» введите название вашего приложения чата.
Выберите приложение чата из результатов. Откроется прямое сообщение.
В новом прямом сообщении с приложением введите
Hello
и нажмитеenter
.Приложение чата поблагодарит вас за добавление и повторит ваше сообщение.
Чтобы добавить доверенных тестировщиков и узнать больше о тестировании интерактивных функций, см. раздел Тестирование интерактивных функций для приложений Google Chat .
Устранение неполадок
Когда приложение или карточка Google Chat возвращает ошибку, в интерфейсе Chat отображается сообщение «Что-то пошло не так». или «Невозможно обработать ваш запрос». Иногда в пользовательском интерфейсе чата не отображается сообщение об ошибке, но приложение или карточка чата выдает неожиданный результат; например, сообщение с карточкой может не появиться.
Хотя сообщение об ошибке может не отображаться в пользовательском интерфейсе чата, доступны описательные сообщения об ошибках и данные журнала, которые помогут вам исправить ошибки, если включено ведение журнала ошибок для приложений чата. Информацию о просмотре, отладке и исправлении ошибок см. в разделе «Устранение неполадок и исправление ошибок Google Chat» .
Очистить
Чтобы избежать списания средств с вашей учетной записи Google Cloud за ресурсы, используемые в этом руководстве, мы рекомендуем вам удалить проект Cloud.
- В консоли Google Cloud перейдите на страницу «Управление ресурсами» . Нажмите Меню > IAM и администрирование > ресурсами .
- В списке проектов выберите проект, который хотите удалить, и нажмите «Удалить .
- В диалоговом окне введите идентификатор проекта и нажмите «Завершить работу», чтобы удалить проект.