Отвечайте на быстрые команды в приложении Google Chat.

На этой странице объясняется, как настроить быстрые команды для вашего приложения Google Chat и отвечать на них.

Быстрая команда — это способ, с помощью которого пользователи могут вызывать приложение чата и взаимодействовать с ним. Чтобы использовать быструю команду, откройте меню интеграции, нажав «Инструменты Google Workspace в чате или беседе, а затем выберите команду приложения, имя которой не начинается с косой черты ( / ). При выборе быстрой команды приложение Chat вызывается напрямую без дополнительных действий со стороны пользователя, что позволяет быстро взаимодействовать с пользователем.

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

Меню интеграции с быстрыми командами
Рис. 1. Меню интеграции, содержащее быстрые команды для приложения чата.

Настройте быструю команду в API Google Chat

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

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

  1. В консоли Google Cloud выберите «Меню» > «API и службы» > «Включенные API и службы» > «API Google Chat».

    Перейдите на страницу API Google Chat.

  2. Нажмите Конфигурация .

  3. В разделе «Команды » нажмите «Добавить команду» .

  4. Введите идентификатор команды, имя, описание и тип команды:

    • Идентификатор команды: число от 1 до 1000, которое ваше приложение Chat использует для распознавания команды и возврата ответа.
    • Имя: отображаемое имя команды. Имена могут содержать до 50 символов и могут включать специальные символы.
      • Используйте короткие, описательные и действенные слова или фразы, чтобы сделать команды понятными пользователю. Например, используйте «Обновить контакт» для команды, которая изменяет запись контакта.
    • Описание: текст, описывающий, что делает команда. Описания могут содержать до 50 символов и включать специальные символы.
      • Описание должно быть кратким и понятным, чтобы пользователи знали, чего ожидать при вызове команды.
      • Сообщите пользователям, отвечает ли приложение Chat всем в группе или лично пользователю, который вызывает команду. Например, для быстрой команды «О программе » вы можете описать ее как «Узнать об этом приложении (видно только вам)» .
    • Тип команды: выберите «Быстрая команда» .

  5. Необязательно: если вы хотите, чтобы приложение Chat отвечало на команду диалоговым окном , установите флажок Открыть диалоговое окно.

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

Быстрая команда теперь настроена для приложения Chat.

Ответ на быструю команду

Когда пользователи вызывают быструю команду, ваше приложение Chat получает событие взаимодействия APP_COMMAND . Полезная нагрузка события содержит объект appCommandMetadata со сведениями о вызванной команде (включая идентификатор команды и тип команды), чтобы вы могли вернуть соответствующий ответ.

В следующем коде показан пример приложения Chat, которое отвечает на команду справки , обрабатывая события взаимодействия APP_COMMAND и определяя, содержит ли полезная нагрузка события соответствующий идентификатор команды. Если полезные данные события содержат идентификатор команды, приложение Chat возвращает личное сообщение:

Скрипт приложений 

// Handle the APP_COMMAND event type.
function onAppCommand(event) {
  // Executes the command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

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

Превратите существующие слэш-команды в быстрые команды

Чтобы превратить существующую косую черту в быструю команду, отредактируйте ее в API Google Chat, изменив тип команды с Косой черты на Быструю команду .

Когда пользователи вызывают быструю команду, ваше приложение Chat получает событие взаимодействия APP_COMMAND вместо события взаимодействия MESSAGE , которое отправляется для команд с косой чертой. Обновите приложение чата для обработки этого типа событий взаимодействия, прочитав полезные данные события, содержащие объект appCommandMetadata со сведениями о быстрой команде, которая была вызвана. См. раздел «Ответ на быструю команду» .