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

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

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

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

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

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

  • Упомяните приложение «Чат», чтобы добавить его в пространство или отправить ему сообщение.
  • Найдите и начните личное сообщение в приложении «Чат». В меню «Приложения» в личных сообщениях отображается название и аватар приложения «Чат».
  • С помощью панели создания сообщения пользователи могут просматривать приложения чата и видеть свое имя, аватар и описание.

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

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

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

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

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

Получив данные о своем приложении «Чат», откройте свой облачный проект и настройте API чата:

  1. В консоли Google Cloud перейдите на страницу Chat API и нажмите на страницу «Конфигурация» :

    Перейдите на страницу настройки API чата.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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