Создайте приложение Google Chat с помощью скрипта Google Apps.

На этой странице объясняется, как создать дополнение Google Workspace, работающее в Google Chat, с использованием Google Apps Script.

Примечание: В Google Chat дополнения отображаются для пользователей как приложения Google Chat. Вы также можете создать своё приложение Chat, используя события взаимодействия с API Google Chat . Подробнее см. в обзоре расширения Google Chat .

Приложение «Чат» позволяет вам отправлять сообщения напрямую и отвечать на них, повторяя ваши сообщения.

На следующей диаграмме показана архитектура и схема обмена сообщениями:

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

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

Цели

• Настройте свою среду.
• Настройте сценарий.
• Настройте дополнение Google Workspace для приложения Chat.
• Протестируйте приложение «Чат».

Предпосылки

• Учетная запись Google Workspace Business или Enterprise с доступом к Google Chat .
• Проект Google Cloud. Чтобы создать его, см. раздел Создание проекта Google 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

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

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

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

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

Настройте сценарий

Чтобы настроить скрипт, используйте шаблон приложения «Чат» со страницы « Начало работы со скриптом приложений», а затем подключите скрипт к своему облачному проекту.

Создайте проект Apps Script

1. На странице «Начало работы» Apps Script перейдите в раздел «Начальные дополнения» и щелкните шаблон приложения «Чат» :

   Откройте шаблон приложения «Чат»

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

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

   2. В поле «Название проекта» введите Add-on Chat app .

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

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

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

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

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

Настройте облачный проект проекта Apps Script.

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

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

Убедитесь, что вы вошли в нужную учётную запись Google, когда открываете проект Apps Script. Текущая учётная запись может иногда незаметно для вас переключиться на учётную запись по умолчанию.

Создайте тестовое развертывание

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

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

1. В проекте скрипта приложений приложения чата нажмите Развернуть > Тестовые развертывания .
2. Скопируйте идентификатор развертывания Head для использования на следующем этапе и нажмите Готово .

Настройте дополнение

Используя развертывание Apps Script, выполните следующие шаги для создания надстройки и развертывания приложения Google Chat:

1. В консоли найдите Google Chat API и нажмите Google Chat API .
2. Нажмите «Управление» .

3. Нажмите «Конфигурация» и настройте приложение чата:

   1. В поле «Имя приложения» введите Add-on Chat app .
   2. В поле URL-адрес аватара введите https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png .
   3. В поле Описание введите Add-on Chat app .
   4. В разделе «Функциональность» выберите Присоединяйтесь к пространствам и групповым беседам .
   5. В разделе «Параметры подключения» выберите Проект скрипта приложений .
   6. В поле «Идентификатор развертывания» вставьте скопированный ранее идентификатор развертывания Head.
   7. В разделе «Видимость» выберите «Определенные люди и группы в вашем домене» и введите свой адрес электронной почты.

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

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

Протестируйте приложение чата

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

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

   Перейти в Google Чат

2. Нажмите новый чат» .
3. В поле Добавить 1 или более человек введите название вашего чат-приложения.

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

   Примечание: Если вы не видите свое приложение Chat в списке результатов, убедитесь, что вы включили свою учетную запись Google Workspace в настройки видимости на странице конфигурации API Chat в консоли Google Cloud.

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

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

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

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

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

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

Уборка

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

Внимание: удаление проекта имеет следующие последствия:

• Всё в проекте будет удалено. Если для этого руководства вы использовали существующий проект, при его удалении будет удалена и вся остальная работа, проделанная вами в этом проекте.
• Пользовательские идентификаторы проектов утеряны. При создании этого проекта вы могли создать собственный идентификатор проекта, который захотите использовать в будущем. Чтобы сохранить URL-адреса, использующие этот идентификатор проекта, например URL-адрес на appspot.com, удалите выбранные ресурсы внутри проекта, а не весь проект.

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

1. В консоли Google Cloud перейдите на страницу «Управление ресурсами» . Выберите « Меню > «IAM и администрирование» > «Управление ресурсами» .

   Перейти к диспетчеру ресурсов

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