Краткое руководство по приложению Google Apps Script Chat

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

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

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

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

Цели

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

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

• Аккаунт Google Workspace для бизнеса или предприятия с доступом к 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 выберите > API и службы > Экран согласия OAuth .

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

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

4. На данный момент вы можете пропустить добавление областей и нажать «Сохранить и продолжить» . В будущем, когда вы создадите приложение для использования за пределами вашей организации Google Workspace, вам необходимо изменить тип пользователя на Внешний , а затем добавить области авторизации, необходимые вашему приложению.

5. Просмотрите сводку регистрации приложения. Чтобы внести изменения, нажмите «Изменить» . Если регистрация приложения выглядит нормально, нажмите «Вернуться на панель управления» .

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

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

Создайте скрипт из шаблона

1. Перейдите на страницу « Начало работы со скриптом приложений» .
2. Щелкните шаблон приложения чата . Возможно, вам придется прокрутить вниз, чтобы увидеть этот шаблон.
3. Нажмите «Проект без названия» , введите Quickstart app и нажмите «Переименовать» .

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

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

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

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

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

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

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

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

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

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

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

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

Опубликуйте приложение чата

Опубликуйте приложение Chat из консоли Google Cloud.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Очистить

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

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

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

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

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

   Зайдите в диспетчер ресурсов

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

Следующие шаги

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