このページでは、Google Chat アプリのクイック コマンドを設定して返信する方法について説明します。
クイック コマンドは、ユーザーが Chat アプリを起動して操作するための方法です。クイック コマンドを使用するには、Chat スペースまたは会話で Google Workspace ツール をクリックして統合メニューを開き、名前がスラッシュ（/）で始まらないアプリコマンドを選択します。クイック コマンドを選択すると、ユーザーからの追加入力なしで Chat アプリが直接起動されるため、ユーザーはすばやく操作できます。
ユーザーは スラッシュ コマンドを使用して Chat アプリを呼び出すこともできます。スラッシュ コマンドと比較して、クイック コマンドは Chat UI でよりユーザー フレンドリーな名前でフォーマットされ、選択するとすぐに呼び出されます。また、スラッシュ コマンドの名前を覚えたり入力したりする必要はありません。
Google Chat API でクイック コマンドを設定する
クイック コマンドを作成する場合や、既存のスラッシュ コマンドをクイック コマンドに更新する場合は、Chat アプリの Google Chat API の構成でコマンドに関する情報を指定する必要があります。
Google Chat API でクイック コマンドを構成する手順は次のとおりです。
Google Cloud コンソールで、メニュー > [API とサービス] > [有効な API とサービス] > [Google Chat API] をクリックします。
[構成] をクリックします。
[詳細設定] の [トリガー] に移動し、[アプリ コマンド] フィールドに HTTP エンドポイントや Apps Script 関数などのトリガーが含まれていることを確認します。クイック コマンドに応答するには、次のセクションでこのトリガーを使用する必要があります。
[コマンド] で [コマンドを追加] をクリックします。
コマンドのコマンド ID、名前、説明、コマンドタイプを入力します。
- コマンド ID: Chat アプリがコマンドの認識とレスポンスを返すために使用する 1 ～ 1,000 の数字。
- 名前: コマンドの表示名。名前は 50 文字までで、特殊文字を含めることができます。
- 短く、説明的で、実行可能な単語やフレーズを使用して、コマンドをユーザーに明確に伝えます。たとえば、連絡先レコードを変更するコマンドには Update contact を使用します。
- 説明: コマンドの機能の説明。説明は 50 文字以内で、特殊文字を含めることができます。
- 説明は簡潔でわかりやすく、コマンドを呼び出すときに何が期待できるかをユーザーに伝えるようにします。
- Chat アプリがスペース内の全ユーザーに返信するか、コマンドを呼び出したユーザーに非公開で返信するかをユーザーに知らせます。たとえば、クイック コマンド「概要」は「このアプリについて（自分だけに表示）」と説明できます。
- コマンドの種類: [クイック コマンド] を選択します。
省略可: Chat アプリがコマンドにダイアログで応答する場合は、[ダイアログを開く] チェックボックスをオンにします。
[保存] をクリックします。
これで、Chat アプリ用にクイック コマンドが構成されました。
クイック コマンドに返信する
ユーザーがクイック コマンドを呼び出すと、クイック コマンドに関する情報を含むイベント オブジェクトが Chat アプリに送信されます。イベント オブジェクトには、呼び出されたコマンドに関する詳細（コマンド ID など）を含む AppCommand ペイロードが含まれるため、適切なレスポンスを返すことができます。
クイック コマンドに応答するには、アプリコマンドトリガーを実装して、Chat アプリがアプリコマンド メタデータを含むイベント オブジェクトを処理できるようにする必要があります。
次のコードは、Help コマンドに返信する Chat アプリの例を示しています。クイック コマンドに応答するため、Chat アプリは アプリコマンド トリガーのイベント オブジェクトを処理します。イベント オブジェクトのペイロードにクイック コマンド ID が含まれている場合、Chat アプリは createMessageAction オブジェクトを含むアクション DataActions を返します。
Apps Script
// 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 でクイック コマンドを構成したときに指定したコマンド ID に置き換えてください。Chat でクイック コマンドをテストするには、Google Workspace ツール をクリックして統合メニューを開き、クイック コマンドを選択します。