Отвечайте на быстрые команды в Google Chat

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

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

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

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

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

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

1. В консоли Google Cloud нажмите menu > API и службы > Включенные API и службы > Google Chat API.

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

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

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

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

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

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

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

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

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

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

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

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

В следующем коде показан пример приложения Chat, которое отвечает на команду «Справка» . Чтобы реагировать на быстрые команды, приложение Chat обрабатывает объекты событий из триггера команды приложения . Если полезные данные объекта события содержат идентификатор быстрой команды, приложение Chat возвращает действие DataActions с объектом createMessageAction :

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {

    // Stores the Google Chat app command metadata as a variable.
    const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;

    if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {

        // Executes the quick command logic based on its ID.
        // Quick command IDs are set in the Google Chat API configuration.
        switch (appCommandMetadata.appCommandId) {
            case HELP_COMMAND_ID:
                return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
                    text: 'The Avatar app replies to Google Chat messages.'
                }}}}};
        }
    }
}

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