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

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

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

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

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

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

Цели

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

Требования

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

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

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

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

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

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

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

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

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

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

  1. В Google API Console нажмите на значок меню > Google Auth platform (Платформа Google Auth) > Branding (Брендинг).

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

  2. Если вы уже настроили платформу Google Auth, то можете задать следующие настройки окна запроса доступа OAuth: Фирменное оформление, Аудитория и Доступ к данным. Если вы видите сообщение Google Auth platform not configured yet (Платформа Google Auth ещё не настроена), нажмите Get Started (Начать).
    1. В разделе Информация о приложении в поле Название приложения введите название приложения.
    2. В поле Электронный адрес службы поддержки укажите адрес, по которому пользователи смогут обращаться с вопросами о согласии.
    3. Нажмите Далее.
    4. В разделе Аудитория выберите Внутреннее.
    5. Нажмите Далее.
    6. В разделе Контактная информация укажите адрес электронной почты, на который вы хотите получать уведомления об изменениях в проекте.
    7. Нажмите Далее.
    8. В разделе Finish (Завершение) ознакомьтесь с Правилами в отношении пользовательских данных сервисов API Google и, если вы согласны с ними, выберите I agree to the Google API Services: User Data Policy (Я принимаю Правила в отношении пользовательских данных сервисов API Google).
    9. Нажмите Продолжить.
    10. Нажмите Создать.
  3. Пока вы можете пропустить добавление областей действия. Если в будущем вы создадите приложение для использования за пределами организации Google Workspace, вам нужно будет изменить тип пользователя на Внешний. Затем добавьте области авторизации, необходимые для вашего приложения. Подробную информацию вы найдете в руководстве по настройке запроса согласия OAuth.

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

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

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

  1. На странице Начало работы в Apps Script перейдите в раздел Google Workspace add-on starters (Стартовые дополнения Google Workspace) и нажмите на шаблон Chat app (Приложение Chat).

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

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

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

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

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

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

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

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

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

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

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

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

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

  3. Нажмите Configuration (Конфигурация) и настройте приложение 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. В поле Идентификатор развертывания вставьте идентификатор развертывания Head, который вы скопировали ранее.
    7. В разделе Видимость выберите Определенные пользователи и группы в вашем домене и введите свой адрес электронной почты.

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

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

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

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

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

    Перейти в Google Chat

  2. Нажмите Создать чат.
  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 перейдите на страницу Управление ресурсами. Нажмите Меню > IAM & Admin (IAM и администрирование) > Manage Resources (Управление ресурсами).

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

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

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

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

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

Чтобы создать приложение Chat, которое не является дополнением Google Workspace, с помощью Apps Script, выполните следующие действия, чтобы создать скрипт из шаблона и настроить приложение Chat, которое не является дополнением.

Как создать скрипт на основе шаблона

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

  2. Нажмите Проект без названия, введите Quickstart app и нажмите Переименовать.

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

  3. В проекте Apps Script приложения Chat нажмите Начать развертывание > Тестовые развертывания.

  4. Скопируйте идентификатор развертывания Head, чтобы использовать его на следующем шаге, и нажмите Готово.

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

Настройте приложение Chat, которое не является дополнением, в API Console:

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

  3. Нажмите Конфигурация и настройте приложение Chat, которое не является дополнением:

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

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