На этой странице объясняется, как настроить и отвечать на команды в приложении Google Chat.
Команды помогают пользователям находить и использовать ключевые функции приложения Chat. Только приложения Chat могут видеть содержимое команды. Например, если пользователь отправляет сообщение с командой с косой чертой, сообщение видно только пользователю и приложению Chat.
Чтобы решить, следует ли вам создавать команды, и понять, как проектировать взаимодействия с пользователем, см. раздел Определение всех путей пользователя .
Типы команд приложения чата
Вы можете создавать команды приложения Chat как слэш-команды или быстрые команды. Чтобы обнаружить и использовать каждый тип команды, пользователи делают следующее:- Команды с косой чертой: пользователи отправляют команды в виде сообщений, вводя косую черту (
/
), а затем предопределенный текст, например/about
. Чат-приложения также могут требовать текст аргумента для команды с косой чертой. Например, команда с косой чертой/search
может требовать текст аргумента, который используется для поискового запроса. - Быстрые команды: пользователи используют команды, открывая меню из области ответа сообщения чата. Чтобы использовать команду, они нажимают «Добавить»
и выберите команду из меню.
Рисунок 1. Пользователи находят и используют слэш-команды, вводя слэш /
в поле ответа, а затем имя команды.Рисунок 2. Пользователи находят и используют быстрые команды из меню в области ответа на сообщение чата.
Предпосылки
HTTP
Надстройка Google Workspace, расширяющая Google Chat. Чтобы создать ее, выполните HTTP quickstart .
Скрипт приложений
Надстройка Google Workspace, расширяющая Google Chat. Чтобы создать ее, выполните краткое руководство по Apps Script .
Настройте команду
В этом разделе объясняется, как выполнить следующие шаги для настройки команды:
- Создайте имя и описание для команды.
- Настройте команду в консоли Google Cloud.
Назовите и опишите команду
Имя команды — это то, что пользователи вводят или выбирают для вызова приложения Chat. Под именем также отображается краткое описание, чтобы подсказать пользователям, как использовать команду:

При выборе названия и описания вашей команды примите во внимание следующие рекомендации:
Чтобы назвать команду:
- Используйте короткие, описательные и действенные слова или фразы, чтобы сделать команды понятными пользователю. Например, вместо имени
Create a reminder
используйтеRemind me
. - Рассмотрите возможность использования уникального или общего имени для вашей команды. Если ваша команда описывает типичное взаимодействие или функцию, вы можете использовать общее имя, которое пользователи узнают и ожидают, например,
Settings
илиFeedback
. В противном случае попробуйте использовать уникальные имена команд, потому что если имя вашей команды совпадает с именем других приложений Chat, пользователю придется фильтровать похожие команды, чтобы найти и использовать вашу.
Чтобы описать команду:
- Описание должно быть кратким и понятным, чтобы пользователи знали, чего ожидать при использовании команды.
- Дайте пользователям знать, есть ли какие-либо требования к форматированию для команды. Например, если вы создаете команду с косой чертой, которая требует текст аргумента, задайте описание как-то вроде
Remind me to do [something] at [time]
. - Дайте пользователям знать, отвечает ли приложение Chat всем в пространстве или только пользователю, который вызывает команду. Например, для быстрой команды
About
вы можете описать ее какLearn about this app (Only visible to you)
.
Настройте команду в консоли Google Cloud
Чтобы создать косую черту или быструю команду, необходимо указать информацию о команде в конфигурации приложения Chat для API Google Chat.
Чтобы настроить команду в API Google Chat, выполните следующие действия: o чтобы настроить слэш-команду в API Google Chat, выполните следующие действия:
В консоли Google Cloud нажмите > API и службы > Включенные API и службы > API Google Chat.
Нажмите Конфигурация .
В разделе Connection settings перейдите в Triggers и укажите данные вашей конечной точки. Вам необходимо использовать этот триггер в следующем разделе для ответа на команду.
- URL конечной точки HTTP : Вы можете указать здесь один общий URL конечной точки HTTP. В качестве альтернативы, чтобы использовать разные конечные точки HTTP для разных триггеров, укажите конечную точку непосредственно в поле команды приложения .
- Apps Script : введите идентификатор развертывания Apps Script. По умолчанию будет вызвана функция
onAppCommand
. Чтобы использовать другую функцию Apps Script, укажите имя пользовательской функции в поле App command .
В разделе «Команды» нажмите «Добавить команду» .
Введите следующую информацию о команде:
- Идентификатор команды: число от 1 до 1000, которое ваше приложение чата использует для распознавания команды и возврата ответа.
- Описание: текст, описывающий, как использовать и форматировать команду. Описания могут содержать до 50 символов.
- Тип команды: выберите Быстрая команда или Косая черта .
- Укажите имя для быстрой команды или косой черты:
- Имя быстрой команды: Отображаемое имя, которое пользователи выбирают из меню для вызова команды. Может содержать до 50 символов и включать специальные символы. Например,
Remind me
. - Имя команды с косой чертой: Текст, который пользователи вводят для вызова команды в сообщении. Должно начинаться со слеша, содержать только текст и может быть длиной до 50 символов. Например,
/remindMe
.
- Имя быстрой команды: Отображаемое имя, которое пользователи выбирают из меню для вызова команды. Может содержать до 50 символов и включать специальные символы. Например,
Необязательно: если вы хотите, чтобы ваше приложение Chat отвечало на команду диалогом, установите флажок Открыть диалог .
Нажмите «Сохранить» .
Теперь команда настроена для приложения «Чат».
Ответить на команду
Когда пользователи используют команду, ваше приложение Chat получает объект события . Полезная нагрузка события содержит объект appCommandPayload
с подробностями о вызванной команде (включая идентификатор команды и тип команды), чтобы вы могли вернуть соответствующий ответ. Объект события отправляется в конечную точку HTTP или функцию Apps Script, которую вы указали при настройке триггера команды App .

/help
чтобы объяснить, как получить поддержку. Следующий код показывает пример приложения Chat, которое отвечает на команду с косой чертой /about
текстовым сообщением. Чтобы ответить на команды с косой чертой, приложение Chat обрабатывает объекты событий из триггера команды App . Когда полезная нагрузка объекта события содержит идентификатор команды с косой чертой, приложение Chat возвращает действие DataActions
с объектом createMessageAction
:
Node.js
// 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 ABOUT_COMMAND_ID = 0;
/**
* Google Cloud Function that responds to events sent from a
* Google Chat space.
*
* @param {Object} req Request sent from Google Chat space
* @param {Object} res Response to send back
*/
exports.avatarApp = function avatarApp(req, res) {
if (req.method === 'GET' || !req.body.chat) {
return res.send('Hello! This function is meant to be used ' +
'in a Google Chat Space.');
}
// Stores the Google Chat event as a variable.
const chatEvent = req.body.chat;
// Handles events that contain payloads about commands
if (chatEvent.appCommandPayload) {
// Stores the Google Chat app command metadata as a variable.
const appCommandMetadata = chatEvent.appCommandPayload.appCommandMetadata;
// Executes the slash command logic based on its ID.
// Slash command IDs are set in the Google Chat API configuration.
switch (appCommandMetadata.appCommandId) {
case ABOUT_COMMAND_ID:
return res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'The Avatar app replies to Google Chat messages.'
}}}}});
}
// Handles MESSAGE events
} else if (chatEvent.messagePayload) {
// Stores the Google Chat event as a variable.
const chatMessage = chatEvent.messagePayload.message;
// Replies with the sender's avatar in a card otherwise.
const displayName = chatMessage.sender.displayName;
const avatarUrl = chatMessage.sender.avatarUrl;
res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'Here\'s your avatar',
cardsV2: [{
cardId: 'avatarCard',
card: {
name: 'Avatar Card',
header: {
title: `Hello ${displayName}!`,
},
sections: [{
widgets: [{
textParagraph: { text: 'Your avatar picture: ' }
}, {
image: { imageUrl: avatarUrl }
}]
}]
}
}]
}}}}});
}
};
Скрипт приложений
// 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 ABOUT_COMMAND_ID = 0;
/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onMessage(event) {
// Stores the Google Chat event as a variable.
const chatMessage = event.chat.messagePayload.message;
// Replies with the sender's avatar in a card otherwise.
const displayName = chatMessage.sender.displayName;
const avatarUrl = chatMessage.sender.avatarUrl;
return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'Here\'s your avatar',
cardsV2: [{
cardId: 'avatarCard',
card: {
name: 'Avatar Card',
header: {
title: `Hello ${displayName}!`,
},
sections: [{
widgets: [{
textParagraph: { text: 'Your avatar picture: ' }
}, {
image: { imageUrl: avatarUrl }
}]
}]
}
}]
}}}}};
}
/**
* 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;
// Executes the slash command logic based on its ID.
// Slash command IDs are set in the Google Chat API configuration.
switch (appCommandMetadata.appCommandId) {
case ABOUT_COMMAND_ID:
return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'The Avatar app replies to Google Chat messages.'
}}}}};
}
}
Чтобы использовать этот пример кода, замените ABOUT_COMMAND_ID
на идентификатор команды, который вы указали при настройке команды в API чата .
Проверьте команду
Чтобы протестировать команду и код, см. раздел Тестирование интерактивных функций для приложений Google Chat .
Чтобы узнать, как протестировать и использовать команду в пользовательском интерфейсе чата, см. раздел Использование приложений в Google Chat в справочной документации Google Chat.
Похожие темы
- Посмотрите примеры приложений чата , которые используют команды
- Отправить сообщение
- Открытые интерактивные диалоги