Настройка приложения Google Chat

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

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

Предпосылки

Выберите отображаемое имя, аватар и описание для вашего приложения чата.

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

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

Перед настройкой приложения чата необходимо подготовить следующую информацию:

Поле Описание Формат
Имя приложения Отображаемое имя приложения «Чат». До 25 буквенно-цифровых символов
URL-адрес аватара Изображение, которое будет отображаться в качестве аватара вашего приложения чата. HTTPS-URL, указывающий на квадратное графическое изображение (PNG или JPEG). Рекомендуемый размер — 256 x 256 пикселей или больше.
Описание Краткое описание назначения приложения «Чат». До 40 буквенно-цифровых символов

В следующем разделе вы укажете эту информацию в настройках конфигурации в API чата.

Настройте приложение чата в консоли Google Cloud

В консоли Google Cloud вы настраиваете информацию о вашем приложении Chat, которая будет отображаться пользователям в Chat, включая отображаемое имя, аватар и описание. Эти данные отображаются только в Chat. Чтобы опубликовать приложение Chat в Marketplace, необходимо также указать информацию, которая будет отображаться в описании вашего приложения Chat в Marketplace .

Когда у вас есть данные вашего приложения Chat, откройте свой проект Cloud и настройте API Chat:

  1. В консоли Google Cloud перейдите на страницу Chat API и нажмите страницу Configuration :

    Перейти на страницу конфигурации API чата

  2. В разделе «Информация о приложении» заполните поля «Название приложения» , «URL-адрес аватара» и «Описание» .

  3. В разделе «Интерактивные функции» установите переключатель « Включить интерактивные функции» в положение «Вкл.» и выполните следующие действия.

    1. В разделе «Функциональность» выберите «Присоединяйтесь к пространствам и групповым беседам» , чтобы сделать приложение чата доступным для установки и использования.

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

    2. В разделе «Настройки подключения» выберите архитектуру, которую вы хотите использовать для получения объектов событий из чата :

      • Чтобы использовать службу HTTP, выберите URL-адрес конечной точки HTTP и укажите URL-адрес.
      • Чтобы использовать проект Google Apps Script, выберите Apps Script и укажите идентификатор развертывания для проекта.

    3. Необязательно: чтобы получать объекты событий для более чем одной конечной точки или функции, перейдите в раздел Настройки подключения > Триггеры и укажите или обновите функции обратного вызова для следующих триггеров чата :

      • Добавлено в пространство : пользователь добавляет приложение Chat в групповую беседу или пространство либо устанавливает приложение Chat для обмена сообщениями 1:1.
      • Сообщение : Пользователь отправляет сообщение в приложение Chat. Например, отправляет личное сообщение в приложение Chat или @упоминает приложение Chat в чат-группе с несколькими людьми.
      • Удалено из пространства : пользователь удаляет или удаляет приложение чата из пространства.
      • Команда приложения : пользователь использует быструю команду или косую черту из приложения чата.

    4. Необязательно: добавьте другие интерактивные функции, такие как быстрые команды , команды с косой чертой или предварительный просмотр ссылок .

    5. В разделе «Видимость» укажите свой адрес электронной почты, чтобы вы могли установить и протестировать приложение Chat перед публикацией в Google Workspace Marketplace. Вы можете указать до пяти пользователей или одну или несколько групп Google из вашей организации Google Workspace.

  4. Необязательно: в разделе «Журналы» установите флажок «Записывать ошибки в журнал», чтобы использовать Google Cloud Logging. Подробнее см. в разделе «Запрос журналов ошибок для приложений чата» в документации по API чата.

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

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

Рекомендации по существующим надстройкам Google Workspace

Приложения чата требуют иной настройки по сравнению с дополнениями Google Workspace, расширяющими возможности других приложений Google Workspace. Если ваше дополнение расширяет возможности других приложений Google Workspace, учтите следующие требования к настройке приложения чата:

  • Возможность установки вашего дополнения из Marketplace должна быть у пользователей и администраторов Google Workspace. Параметры установки настраиваются в SDK Google Workspace Marketplace.
  • Приложения чата не используют имя и логотип, которые вы настраиваете для других приложений Google Workspace в объекте addons.common манифеста .
  • Для дополнений, опубликованных в Google Workspace Marketplace, невозможно сохранить черновик изменений в настройках конфигурации API Google Chat . После обновления и сохранения настроек конфигурации API Chat обновлённое приложение Chat станет доступно всем существующим пользователям. Чтобы обновить информацию о дополнении в Marketplace, вы можете создать черновик перед отправкой каких-либо изменений.

  • Если вы создали свое дополнение с помощью Apps Script:

  • Если вы создали надстройку с помощью HTTP-сервиса, не указывайте информацию о конфигурации приложения Chat в манифесте и развёртываниях, создаваемых с помощью API дополнений Google Workspace. HTTP-развёртывания, указанные в Google Workspace Marketplace SDK, используются только для других приложений Google Workspace.