このページは Cloud Translation API によって翻訳されました。

Google Chat アプリとしてスラッシュコマンドに応答する

このページでは、Google Chat アプリのスラッシュコマンドを設定して応答する方法について説明します。

スラッシュコマンドは、ユーザーが Chat アプリを呼び出して操作する一般的な方法です。スラッシュコマンドを使用すると、ユーザーは Chat アプリの主要な機能を簡単に見つけ、使用できます。

スラッシュコマンドを使用するには、スラッシュ（/）と短いテキストコマンド（/about など）を入力して、Chat アプリに関する情報を取得します。使用可能なスラッシュコマンドは、Google Chat にスラッシュを入力すると確認できます。Chat アプリで使用可能なコマンドが一覧表示されます。

スラッシュコマンドウィンドウ — **図 1**: ユーザーが Google Chat にスラッシュを入力したときに表示されるウィンドウ。

スラッシュコマンドを設定するかどうかを判断し、ユーザーインタラクションを設計する方法については、すべてのユーザージャーニーを定義するをご覧ください。

非公開の返信を含むスラッシュコマンド

ユーザーがスラッシュコマンドを含むメッセージを送信すると、そのメッセージはユーザーと Chat アプリにのみ表示されます。複数のユーザーが参加するスペースに Chat アプリを追加するように構成している場合は、スラッシュコマンドに非公開で返信して、ユーザーと Chat アプリの間のやり取りを非公開にすることを検討してください。

たとえば、スペースで見つけられた Chat アプリについてユーザーが学習するには、/about や /help などのコマンドを使用します。スペース内の他のユーザーに通知しないように、Chat アプリは Chat アプリの使用方法やサポートの利用方法に関する情報を非公開で返信できます。

前提条件

Node.js

インタラクティブ機能が有効になっている Google Chat アプリ。HTTP サービスを使用してインタラクティブな Chat アプリを作成するには、こちらのクイックスタートを完了してください。

Apps Script

インタラクティブ機能が有効になっている Google Chat アプリ。Apps Script でインタラクティブな Chat アプリを作成するには、こちらのクイックスタートを完了してください。

Python

Java

スラッシュコマンドを設定する

このセクションでは、次の手順でスラッシュコマンドを設定する方法について説明します。

スラッシュコマンドに名前を作成します。
Google Chat API でスラッシュコマンドを構成します。

スラッシュコマンドに名前を付ける

スラッシュコマンドの名前は、ユーザーが Chat メッセージに入力して Chat アプリを呼び出すものです。名前の下に簡単な説明も表示され、コマンドの使用方法についてユーザーに提示します。

スラッシュコマンドの名前と説明を選択する際は、次の推奨事項を検討してください。

スラッシュコマンドに名前を付けるには:
- 短く、説明的で、実行可能な単語やフレーズを使用して、コマンドをユーザーにとって明確でシンプルにします。たとえば、/createAReminder ではなく /remindMe を使用します。
- コマンドに複数の単語が含まれている場合は、最初の単語をすべて小文字にして、それ以降の単語の最初の文字を大文字にすることで、ユーザーがコマンドを読みやすくします。たとえば、/updatecontact ではなく /updateContact を使用します。
- コマンドに一意の名前を使用するか、共通の名前を使用するかを検討します。コマンドが一般的なインタラクションや機能を表す場合は、ユーザーが認識し、期待する一般的な名前（/settings や /feedback など）を使用できます。それ以外の場合は、一意のコマンド名を使用することをおすすめします。コマンド名が他の Chat アプリと同じである場合、ユーザーは類似のコマンドをフィルタして、自分のコマンドを見つけて使用する必要があります。
スラッシュコマンドを説明するには:
- コマンドを呼び出すときにユーザーが期待する結果を把握できるように、説明は簡潔で明確にします。
- コマンドに書式設定の要件がある場合は、ユーザーに伝えます。たとえば、引数テキストを必要とする /remindMe コマンドを作成する場合は、説明を Remind me to do [something] at [time] などに設定します。
- Chat アプリがスペース内の全ユーザーに返信するか、コマンドを呼び出したユーザーに非公開で返信するかをユーザーに知らせます。たとえば、スラッシュコマンド /about は Learn about this app (Only visible to you) と記述できます。

Google Chat API でスラッシュコマンドを構成する

スラッシュコマンドを作成するには、Google Chat API 用に Chat アプリの構成でコマンドに関する情報を指定する必要があります。

Google Chat API でスラッシュコマンドを構成するには、次の操作を行います。

Google Cloud コンソールで、メニュー > [API とサービス] > [有効な API とサービス] > [Google Chat API] をクリックします。

Google Chat API ページに移動
[構成] をクリックします。
[スラッシュコマンド] で [スラッシュコマンドを追加] をクリックします。
コマンドの名前、コマンド ID、説明を入力します。
1. 名前: コマンドの表示名と、ユーザーがアプリを起動するために入力する名前。先頭はスラッシュにする必要があります。テキストのみを含め、最大 50 文字にすることができます。
2. 説明: コマンドの使用方法と形式を説明するテキスト。説明の最大文字数は 50 文字です。
3. コマンド ID: Chat アプリがスラッシュコマンドを認識してレスポンスを返すために使用する 1 ～ 1,000 の数字。
省略可: Chat アプリがコマンドにダイアログで応答する場合は、[ダイアログを開く] チェックボックスをオンにします。
[保存] をクリックします。

これで、Chat アプリ用にスラッシュコマンドが構成されました。

スラッシュコマンドに応答する

ユーザーがスラッシュコマンドを含む Chat メッセージを作成すると、Chat アプリは MESSAGE インタラクションイベントを受信します。イベントペイロードには、slashCommand オブジェクトと slashCommandMetadata オブジェクトが含まれます。これらのオブジェクトには、メッセージで使用されたコマンドに関する詳細（コマンド ID など）が含まれるため、適切なレスポンスを返すことができます。

Cymbal Labs の Chat アプリの非公開メッセージ。このメッセージには、Chat アプリが Cymbal Labs によって作成されたこと、ドキュメントへのリンク、サポートチームへの連絡先のリンクが記載されています。 — Chat アプリは、スラッシュコマンド `/help` に非公開で応答し、サポートを受ける方法を説明します。

次のコードは、MESSAGE インタラクションイベントを処理し、メッセージに一致するコマンド ID が含まれているかどうかを検出して、/about スラッシュコマンドに返信する Chat アプリの例を示しています。メッセージにコマンド ID が含まれている場合、Chat アプリは非公開メッセージを返します。

Node.js

node/avatar-app/index.js

GitHub で表示

/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

Apps Script

apps-script/avatar-app/avatar-app.gs

GitHub で表示

// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/avatar-app/main.py

GitHub で表示

def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}

Java

java/avatar-app/src/main/java/AvatarApp.java

GitHub で表示

/**
 * Handles slash and quick commands.
 *
 * @param event    The Google Chat event.
 * @param response The HTTP response object.
 */
private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
  int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
    case HELP_COMMAND_ID:
      Message helpMessage = new Message();
      helpMessage.setText("The Avatar app replies to Google Chat messages.");
      helpMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(helpMessage));
      return;
  }
}

Chat API でスラッシュコマンドを構成したときに指定したコマンド ID を使用して、ABOUT_COMMAND_ID を設定します。このコードをテストするには、Google Chat アプリのインタラクティブ機能をテストするをご覧ください。

Google Chat アプリとしてスラッシュ コマンドに応答する

非公開の返信を含むスラッシュ コマンド

前提条件

Node.js

Apps Script

Python

Java

スラッシュ コマンドを設定する

スラッシュ コマンドに名前を付ける

Google Chat API でスラッシュ コマンドを構成する

スラッシュ コマンドに応答する

Node.js

Apps Script

Python

Java

関連トピック

Google Chat アプリとしてスラッシュコマンドに応答する

非公開の返信を含むスラッシュコマンド

スラッシュコマンドを設定する

スラッシュコマンドに名前を付ける

Google Chat API でスラッシュコマンドを構成する

スラッシュコマンドに応答する