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

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

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

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

Архитектура чат-приложения, реализованного с помощью Apps Script.

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

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

Цели

  • Настройте свою среду.
  • Настройте скрипт.
  • Настройте приложение «Чат».
  • Протестируйте приложение «Чат».

Предварительные требования

Настройте свою среду

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

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

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

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

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

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

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

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

Включить API

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

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

  1. В консоли Google API перейдите в > Платформа аутентификации Google > Брендинг .

    Перейти к разделу «Брендинг»

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

Настройте скрипт

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

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

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

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

  2. В открывшемся новом проекте Apps Script присвойте проекту следующее имя:

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

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

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

In the future, if you want to use certain Google APIs or publish your app, you must associate your Cloud project with your Apps Script project. For this guide, you don't need to do so. To learn more, see the Google Cloud projects guide .

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

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

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

  1. В проекте Apps Script приложения «Чат» нажмите «Развернуть» > «Проверить развертывания» .
  2. Скопируйте идентификатор развертывания Head для использования на следующем шаге и нажмите «Готово» .

Настройте приложение «Чат».

Для настройки приложения Google Chat выполните следующие действия:

  1. В консоли API найдите Google 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. В разделе «Настройки подключения» выберите проект Apps Script .
    6. В поле «Идентификатор развертывания» вставьте ранее скопированный идентификатор развертывания Head.
    7. В разделе «Видимость» выберите «Конкретные люди и группы в вашем домене» и введите свой адрес электронной почты.

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

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

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

Чтобы протестировать приложение «Чат», откройте личное сообщение в приложении «Чат» и отправьте сообщение:

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

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

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

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

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

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

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

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

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

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

Уборка

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

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

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

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