このページでは、 Google Chat アプリ。
スラッシュ コマンドは、ユーザーがコマンドラインで Chat アプリ。スラッシュ コマンドを使用すると、 Chat 用アプリの主な機能を使用する。
スラッシュ コマンドを使用するには、スラッシュ(/
)を入力してから短いテキスト コマンドを入力します。
たとえば、/about
を使用して、Chat 用アプリに関する情報を取得できます。
「/」を入力すると、使用可能なスラッシュ コマンドを見つけることができます。
使用可能なコマンドのリストがウィンドウに表示されます。
Chat アプリ:
![スラッシュ コマンド ウィンドウ](https://developers.google.cn/static/workspace/chat/images/slash-command-window.png?authuser=6&hl=ja)
ユーザーがスラッシュ コマンドを含むメッセージを送信した場合、 ユーザーと Chat アプリに公開されます。
スラッシュ コマンドを設定するかどうかの判断方法と、 ユーザー操作の設計について詳しくは、以下をご覧ください。 すべてのユーザー ジャーニーを定義する。
前提条件
Node.js
インタラクティブ機能を有効にする Google Chat アプリ。新しい HTTP サービスを使用したインタラクティブな Chat アプリについては、こちらのクイックスタートを完了します。
Apps Script
インタラクティブ機能を有効にする Google Chat アプリ。新しい 対話型の Chat アプリを使用するには、このクイックスタートを完了します。
Python
インタラクティブ機能を有効にする Google Chat アプリ。新しい HTTP サービスを使用したインタラクティブな Chat アプリについては、こちらのクイックスタートを完了します。
スラッシュ コマンドを設定する
このセクションでは、次の手順でスラッシュを設定する方法について説明します。 command:
- スラッシュ コマンドの名前を作成します。
- Google Chat API でスラッシュ コマンドを構成します。
スラッシュ コマンドに名前を付ける
スラッシュ コマンドの名前は、ユーザーが Chat メッセージに入力する Chat 用アプリを呼び出すことができます。簡単な説明も が名前の下に表示され、コマンドの使用方法の詳細をユーザーに促すことができます。
![スラッシュ コマンドの名前と説明](https://developers.google.cn/static/workspace/chat/images/slash-command-description.png?authuser=6&hl=ja)
スラッシュ コマンドの名前と説明を選択する場合は、 次の推奨事項に従ってください。
スラッシュ コマンドに名前を付けるには:
- 簡潔でわかりやすく、実用的な単語やフレーズを使用して、
明確でシンプルなものにします。たとえば、
/createAReminder
、/remindMe
を使用します。 - コマンドに複数の単語が含まれている場合は、ユーザーがコマンドを読んで理解できるようサポートします。
最初の単語にはすべて小文字を使用し、最初の単語は大文字にします。
追加単語の文字。たとえば、
/updatecontact
ではなく、/updateContact
を使用します。 - コマンドに一意の名前と共通名のどちらを使用するかを検討してください。条件
一般的な操作や機能が説明されている場合、
ユーザーが認識して想定している一般的な名前(
/settings
や/feedback
。それ以外の場合は、一意のコマンド名を使用するようにしてください。 コマンド名が同じである場合、ユーザーは 同様のコマンドでフィルタし、自分のコマンドを見つけて使用します。
- 簡潔でわかりやすく、実用的な単語やフレーズを使用して、
明確でシンプルなものにします。たとえば、
スラッシュ コマンドの説明を取得するには:
- 説明は簡潔でわかりやすく、何をしようとしているのかがユーザーにわかるようにする 実行されるようにします。
- コマンドのフォーマット要件がある場合は、ユーザーにその旨を伝えます。
たとえば、引数を必要とする
/remindMe
コマンドを作成する場合 説明をRemind me to do [something] at [time]
などに設定してください。 - Chat 用アプリから
コマンドを呼び出すユーザーに限定公開できます。
たとえば、スラッシュ コマンド
/about
の場合は、次のように記述できます。Learn about this app (Only visible to you)
。コメントに非公開で返信するには、 スラッシュ コマンドについて詳しくは、プライベート メッセージで応答するをご覧ください。
Google Chat API でスラッシュ コマンドを構成する
スラッシュ コマンドを作成するには、コマンドに関する情報を Chat 用アプリの Google Chat API の構成。
Google Chat API でスラッシュ コマンドを構成する手順は次のとおりです。 手順:
Google Cloud コンソールで、メニュー アイコン > API とサービス > 有効な API とサービス > Google Chat API
[構成] をクリックします。
[スラッシュ コマンド] で [スラッシュ コマンドを追加] をクリックします。
コマンドの名前、コマンド ID、説明を入力します。
- 名前: コマンドの表示名とユーザーの入力 アプリを呼び出すことができますスラッシュで始まり、テキストのみを含む必要があります。また、 50 文字以内。
- 説明: 使用方法と書式設定を説明するテキスト 指定できます。説明文は半角 50 文字(全角 25 文字)以内で入力できます。
- コマンド ID: 使用している 1 ~ 1,000 の数値 Chat アプリはスラッシュ コマンドを認識するために使用する レスポンスが返されます。
省略可: Chat 用アプリが ダイアログ付きでコマンドを実行する場合は、 [ダイアログを開く] チェックボックスをオンにします。
[保存] をクリックします。
これで、Chat 用アプリ用のスラッシュ コマンドが構成されました。
スラッシュ コマンドに応答する
スラッシュ コマンドを含む Chat メッセージを作成すると、
Chat アプリが MESSAGE
インタラクション イベントを受信します。
イベント ペイロードには、スラッシュ コマンド、
slashCommand
を含む
および slashCommandMetadata
表示されます。これらのフィールドを使用してコマンド ID を特定し、カスタム
レスポンスが返されます。
次の例は、MESSAGE
インタラクション イベントの JSON ペイロードを示しています。
(スラッシュ コマンド /vote
を含む):
{
...
"message": {
...
"text": "/vote yes",
"argumentText": " yes",
"slashCommand": {
"commandId": 2
},
"annotations": [
{
"length": 5,
"startIndex": 0,
"type": "SLASH_COMMAND",
"slashCommand": {
"commandName":"/vote",
"commandId":1,
"type": "INVOKE",
"bot": {
"avatarUrl": "https://www.example.com/images/vote-app-icon.png",
"displayName": "Voter Chat App",
"name": "users/1234567890987654321",
"type": "BOT"
}
}
}
]
}
}
スラッシュ コマンドに応答するには、slashCommand
フィールドが
がイベント ペイロードに存在し、存在する場合はコマンドに対するレスポンスを返します。
次のコードサンプルは、MESSAGE
インタラクション イベントに応答する方法を示しています。
含まれていることがわかります。
Node.js
/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} function in response to a slash command.
*/
exports.onMessage = function onMessage(req, res) {
// Stores the Google Chat event as a variable.
var event = req.body;
// Checks for the presence of event.message.slashCommand.
if (event.message.slashCommand) {
switch (event.message.slashCommand.commandId) {
case ID: // The ID for your slash command
res.json(runFunction); // The response to the slash command.
}
}
Apps Script
/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} function in response to a slash command.
*/
function onMessage(event) {
// Checks for the presence of event.message.slashCommand
if (event.message.slashCommand) {
switch (event.message.slashCommand.commandId) {
case ID: // The ID for your slash command
return runFunction; // The response to the slash command.
}
}
}
Python
from typing import Any, Mapping
import flask
import functions_framework
@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
"""Responds to a MESSAGE event in Google Chat that includes a slash command.
Args:
req (flask.Request): the event object from Chat API.
Returns:
Mapping[str, Any]: function in response to a slash command.
"""
if req.method == 'GET':
return 'Sorry, this function must be called from a Google Chat.'
request = req.get_json(silent=True)
if slash_command := request.get('message', dict()).get('slashCommand'):
command_id = slash_command['commandId']
if command_id == ID:
return runFunction
このコードを使用するには、次のように置き換えます。
ID
: 作成時に指定するコマンド ID Google Chat API でスラッシュ コマンドを構成してください。runFunction
: レスポンスを作成する関数 使用します。
省略可: プライベート メッセージで返信する
スラッシュ コマンドを含むメッセージは、 コマンドを受信した Chat アプリに対して行われます。条件 Chat 用アプリがスペースに追加されるよう スラッシュ コマンドに返信することも、 やり取りのプライバシーを守るため、プライバシーを守りながら、 Chat アプリ。
たとえば、チームが Chat 用アプリを使用していて、
使用すると、ユーザーは次のようなスラッシュ コマンドを呼び出すことができます。
/myCases
して、自分に割り当てられたサポートケースを表示します。チームが
このスラッシュ コマンドを使用するスペースに
Chat アプリがそのスペース内でのみ応答する必要があることを
できます。ユーザーのサポートケースがスペース内の全員に投稿されないように、
Chat アプリは非公開で応答できます。
スラッシュ コマンドに非公開で応答する方法については、 Google Chat ユーザーにプライベート メッセージを送信する
詳細な例: Rolodex Chat アプリを使用して連絡先を設定する
次の例は、メッセージに返信する Chat 用アプリです。 使用できます。
/help
コマンドは、取得方法を説明するテキスト メッセージを返します。 Chat 用アプリでサポートを提供します。コマンド ID が設定されます。 宛先:1
/createContact
コマンドにより、ユーザーが入力するためのダイアログが表示されます。 詳細を表示できます。コマンド ID は2
に設定されます。
このサンプルを実行する前に、次の操作を行います。 Google Chat API でスラッシュ コマンドを構成します。
Node.js
/**
* Responds to messages that have links whose URLs
* match URL patterns configured for link previews.
*
* @param {Object} event The event object from Chat
* API.
*
* @return {Object} Response from the Chat app
* attached to the message with the previewed link.
*/
exports.onMessage = function onMessage(req, res) {
// Store the Google Chat event as a variable.
const event = req.body;
if (req.method === "GET" || !event.message) {
res.send("Hello! This function is meant to be used in a Google Chat " +
"Space.");
}
// Checks for the presence of event.message.slashCommand.
// If the slash command is "/help", responds with a text message.
// If the slash command is "/createContact", opens a dialog.
if (event.message.slashCommand) {
switch (event.message.slashCommand.commandId) {
case 1: // /help
res.json({"text": "Contact bot helps you update your address book!"});
case 2: // /createContact
res.json(openDialog(event));
}
}
// If the Chat app doesn"t detect a slash command, it responds
// with a card that prompts the user to add a contact
else {
res.json({
"cardsV2": [{
"cardId": "addContact",
"card": {
"header": {
"title": "Rolodex",
"subtitle": "Manage your contacts!",
"imageUrl": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
"imageType": "CIRCLE"
},
"sections": [
{
"widgets": [
{
"buttonList": {
"buttons": [
{
"text": "Add Contact",
"onClick": {
"action": {
"function": "openDialog",
"interaction": "OPEN_DIALOG"
}
}
}
]
}
}
]
}
]
}
}]
});
}
// Respond to button clicks on attached cards
if (event.type === "CARD_CLICKED") {
if (event.common.invokedFunction === "openDialog") {
res.json(openDialog(event));
}
if (event.common.invokedFunction === "openSequentialDialog") {
res.json(openSequentialDialog(event));
}
if (event.common.invokedFunction === "confirmDialogSuccess") {
res.json(confirmDialogSuccess(event));
}
}
};
/**
* Opens and starts a dialog that lets users add details about a contact.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openDialog(event) {
return {
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Name",
"type": "SINGLE_LINE",
"name": "name"
}
},
{
"textInput": {
"label": "Address",
"type": "MULTIPLE_LINE",
"name": "address"
}
},
{
"decoratedText": {
"text": "Add to favorites",
"switchControl": {
"controlType": "SWITCH",
"name": "saveFavorite"
}
}
},
{
"decoratedText": {
"text": "Merge with existing contacts",
"switchControl": {
"controlType": "SWITCH",
"name": "mergeContact",
"selected": true
}
}
},
{
"buttonList": {
"buttons": [
{
"text": "Next",
"onClick": {
"action": {
"function": "openSequentialDialog"
}
}
}
]
}
}
]
}
]
}
}
}
}
};
};
/**
* Opens a second dialog that lets users add more contact details.
*
* @param {object} event the event object from Google Chat.
*
* @return {object} open a dialog.
*/
function openSequentialDialog(event) {
return {
"action_response": {
"type": "DIALOG",
"dialog_action": {
"dialog": {
"body": {
"sections": [
{
"header": "Add new contact",
"widgets": [
{
"textInput": {
"label": "Notes",
"type": "MULTIPLE_LINE",
"name": "notes"
}
},
{
"selectionInput": {
"type": "RADIO_BUTTON",
"label": "Contact type",
"name": "contactType",
"items": [
{
"text": "Work",
"value": "Work",
"selected": false
},
{
"text": "Personal",
"value": "Personal",
"selected": false
}
]
}
},
{
"buttonList": {
"buttons": [
{
"text": "Submit",
"onClick": {
"action": {
"function": "confirmDialogSuccess",
"parameters": [
{
"key": "confirmDialogSuccess",
"value": "confirmDialogSuccess"
}
]
}
}
}
]
},
"horizontalAlignment": "END"
}
]
}
]
}
}
}
}
};
}
/**
* Checks for a form input error, the absence of
* a "name" value, and returns an error if absent.
* Otherwise, confirms successful receipt of a dialog.
*
* Confirms successful receipt of a dialog.
*
* @param {Object} event the event object from Chat API.
*
* @return {object} open a Dialog in Google Chat.
*/
function receiveDialog(event) {
// Checks to make sure the user entered a name
// in a dialog. If no name value detected, returns
// an error message.
if (event.common.formInputs.contactName.stringInputs.value[0] === "") {
return {
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": {
"statusCode": "OK",
"userFacingMessage": "Don't forget to name your new contact!"
}
}
}
};
// Otherwise the app indicates that it received
// form data from the dialog. Any value other than "OK"
// gets returned as an error. "OK" is interpreted as
// code 200, and the dialog closes.
} else {
return {
"actionResponse": {
"type": "DIALOG",
"dialogAction": {
"actionStatus": "OK"
}
}
};
}
}
Apps Script
この例では、メッセージにカード メッセージを送信する際に、 カード JSON。 また、 Apps Script カードサービス。
Python
from typing import Any, Mapping
import flask
import functions_framework
@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
"""Responds to a MESSAGE event in Google Chat that includes the /createContact
slash command by opening a dialog.
Args:
req (flask.Request): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
if req.method == 'GET':
return 'Sorry, this function must be called from a Google Chat.'
request = req.get_json(silent=True)
if request.get('type') == 'CARD_CLICKED':
invoked_function = request.get('common', dict()).get('invokedFunction')
if invoked_function == 'open_dialog':
return open_dialog(request)
elif invoked_function == 'open_sequential_dialog':
return open_dialog(request)
elif invoked_function == "receive_dialog":
return receive_dialog(request)
else:
return {
'cardsV2': [{
'cardId': 'addContact',
'card': {
'header': {
'title': 'Rolodex',
'subtitle': 'Manage your contacts!',
'imageUrl': 'https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png',
'imageType': 'CIRCLE'
},
'sections': [
{
'widgets': [
{
'buttonList': {
'buttons': [
{
'text': 'Add Contact',
'onClick': {
'action': {
'function': 'open_dialog',
'interaction': 'OPEN_DIALOG'
}
}
}
]
}
}
]
}
]
}
}]
}
def open_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a dialog in Google Chat.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Name',
'type': 'SINGLE_LINE',
'name': 'name'
}
},
{
'textInput': {
'label': 'Address',
'type': 'MULTIPLE_LINE',
'name': 'address'
}
},
{
'decoratedText': {
'text': 'Add to favorites',
'switchControl': {
'controlType': 'SWITCH',
'name': 'saveFavorite'
}
}
},
{
'decoratedText': {
'text': 'Merge with existing contacts',
'switchControl': {
'controlType': 'SWITCH',
'name': 'mergeContact',
'selected': True
}
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Next',
'onClick': {
'action': {
'function': 'open_sequential_dialog'
}
}
}
]
}
}
]
}
]
}
}
}
}
}
def open_sequential_dialog(request: Mapping[str, Any]) -> Mapping[str, Any]:
"""Opens a second dialog that lets users add more contact details.
Args:
request (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: open a Dialog in response to a card's button click.
"""
return {
'action_response': {
'type': 'DIALOG',
'dialog_action': {
'dialog': {
'body': {
'sections': [
{
'header': 'Add new contact',
'widgets': [
{
'textInput': {
'label': 'Notes',
'type': 'MULTIPLE_LINE',
'name': 'notes'
}
},
{
'selectionInput': {
'type': 'RADIO_BUTTON',
'label': 'Contact type',
'name': 'contactType',
'items': [
{
'text': 'Work',
'value': 'Work',
'selected': False
},
{
'text': 'Personal',
'value': 'Personal',
'selected': False
}
]
}
},
{
'buttonList': {
'buttons': [
{
'text': 'Submit',
'onClick': {
'action': {
'function': 'receive_dialog',
'parameters': [
{
'key': 'receiveDialog',
'value': 'receiveDialog'
}
]
}
}
}
]
},
'horizontalAlignment': 'END'
}
]
}
]
}
}
}
}
}
def receive_dialog(event: Mapping[str, Any]) -> Mapping[str, Any]:
"""Checks for a form input error, the absence of a "name" value, and returns
an error if absent. Otherwise, confirms successful receipt of a dialog.
Args:
event (Mapping[str, Any]): the event object from Chat API.
Returns:
Mapping[str, Any]: the response.
"""
if event.get('common', dict()) \
.get('formInputs', dict()).get('contactName', dict()) \
.get('stringInputs').get('value', list()):
return {
'actionResponse': {
'type': 'DIALOG',
'dialogAction': {
'actionStatus': 'OK'
}
}
}
else:
return {
'actionResponse': {
'type': 'DIALOG',
'dialogAction': {
'actionStatus': "Don't forget to name your new contact!"
}
}
}