Google Chat アプリのコマンドに応答する

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

コマンドを使用すると、ユーザーは Chat アプリの主要な機能を見つけて使用できます。コマンドの内容を確認できるのは Chat アプリのみです。たとえば、ユーザーがスラッシュコマンドを含むメッセージを送信した場合、そのメッセージはユーザーと Chat アプリにのみ表示されます。

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

Chat アプリのコマンドの種類

Chat アプリのコマンドは、スラッシュコマンド、クイックコマンド、メッセージ操作として作成できます。各コマンドタイプを使用するには、ユーザーは次の操作を行います。

スラッシュコマンド: ユーザーは、メニューからスラッシュコマンドを選択するか、スラッシュ（/）を入力してから、/about などの事前定義されたテキストを入力します。通常、Chat アプリでは、スラッシュコマンドの引数テキストが必要です。

Chat アプリでユーザーからの追加の入力が必要な場合は、スラッシュコマンドを作成します。たとえば、ユーザーが検索する語句（/search receipts など）を入力した後に実行される /searchというスラッシュコマンドを作成できます。
クイックコマンド: ユーザーは、Chat メッセージの返信欄からメニューを開いてコマンドを使用します。コマンドを使用するには、[追加] をクリックして、メニューからコマンドを選択します。

Chat アプリが追加の入力を待たずにユーザーにすぐに応答できる場合は、クイックコマンドを作成します。たとえば、画像ですぐに応答する Random image というクイックコマンドを作成できます。
メッセージ操作: ( デベロッパープレビュー) ユーザーは、メッセージにカーソルを合わせてその他メニューをクリックして、メッセージ操作を使用します。コマンドを使用するには、その他メニューを開いて、コマンドをメニューから選択します。

Chat アプリがメッセージのコンテキストに基づいてアクションを実行できる場合は、メッセージ操作を作成します。

次の図は、ユーザーがスラッシュコマンドとクイックコマンド、メッセージ操作のメニューを見つける方法を示しています。

ユーザーがスラッシュコマンドとクイックコマンドのメニューを見つけます。 — ユーザーは、スラッシュコマンドとクイックコマンドのメニューを見つけます。

ユーザーがメッセージ操作を含むメッセージコンテキストメニューを見つけます。 — ユーザーは、[Remind me] メッセージ操作を含むメッセージコンテキストメニューを見つけます。

前提条件

Node.js

インタラクションイベントを受信して応答する Google Chat アプリ。HTTP サービスを使用してインタラクティブな Chat アプリを作成するには、このクイックスタートを完了してください。

Apps Script

インタラクションイベントを受信して応答する Google Chat アプリ。Apps Script でインタラクティブな Chat アプリを作成するには、このクイックスタートを完了してください。

Python

Java

コマンドを設定する

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

コマンドの名前と説明を作成します。
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 コンソールでコマンドを構成する

スラッシュコマンド、クイックコマンド、メッセージ操作を作成するには、Google Chat API の Chat アプリの構成でコマンドまたは操作に関する情報を指定します。

Google Chat API でコマンドを構成する手順は次のとおりです。

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

Google Chat API ページに移動
[構成] をクリックします。
[コマンド] で、[コマンドを追加] をクリックします。
コマンドのコマンド ID、説明、コマンドタイプ、名前を入力します。
- コマンド ID: Chat アプリがコマンドを認識してレスポンスを返すために使用する 1 ～ 1,000 の数値。
- 説明: コマンドの動作を説明するテキスト。説明は 50 文字以内で、特殊文字を含めることができます。
- コマンドタイプ: [クイックコマンド]、[スラッシュコマンド]、[メッセージ操作] のいずれかを選択します。
- コマンドの名前を指定します。
  - クイックコマンド名: ユーザーがメニューから選択してコマンドを呼び出す表示名。50 文字以内で、特殊文字を含めることができます。例: Remind me。
  - スラッシュコマンド名: ユーザーがメッセージでコマンドを呼び出すために入力するテキスト。スラッシュで始まり、テキストのみを含み、50 文字以内で指定する必要があります。例: /remindMe。
  - メッセージ操作名: ( デベロッパープレビュー) ユーザーがメニューから選択してメッセージ操作を呼び出す表示名。50 文字以内で、特殊文字を含めることができます。例: Remind me。
省略可: 読み込み通知メッセージ: ( デベロッパープレビュー) メッセージ操作の実行中にユーザーに表示するトースト通知メッセージ。ダイアログを開かないメッセージ操作でのみ使用できます。
省略可: Chat アプリがコマンドにダイアログで応答するようにする場合は、 [ダイアログを開く] チェックボックスをオンにします。
[保存] をクリックします。

これで、Chat アプリのコマンドが構成されました。

コマンドに応答する

ユーザーがコマンドを使用すると、Chat アプリはインタラクションイベントを受信します。イベントペイロードには、呼び出されたコマンドの詳細（コマンド ID やコマンドタイプなど）を含むメタデータが含まれているため、適切なレスポンスを返すことができます。

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

各タイプのコマンドに応答するには、イベントペイロードでさまざまなイベントタイプとメタデータオブジェクトを処理する必要があります。

コマンドタイプ	イベントの種類	コマンドメタデータ
スラッシュコマンド	`MESSAGE`	`message.slashCommand` または `message.annotation.slashCommand`
クイックコマンド	`APP_COMMAND`	`appCommandMetadata`
メッセージ操作	`APP_COMMAND`	`appCommandMetadata`

メッセージでコマンドに応答する方法については、次のセクションをご覧ください。

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

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

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;
  }
}

ABOUT_COMMAND_ID は、Google Cloud コンソールでコマンドを構成したときに指定したコマンド ID に置き換えます。

クイックコマンドに応答する

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

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 で表示

/**
 * Handles the APP_COMMAND event type. This function is triggered when a user
 * interacts with a quick command within the Google Chat app.  It responds
 * based on the command ID.
 *
 * @param {Object} event The event object from Google Chat, containing details
 *     about the app command interaction.  It includes information like the
 *     command ID and the user who triggered it.
 */
function onAppCommand(event) {
  // Executes the quick command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_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;
  }
}

HELP_COMMAND_ID は、Google Cloud コンソールでコマンドを構成したときに指定したコマンド ID に置き換えます。

メッセージ操作に応答する

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

Node.js

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @param {Object} res The HTTP response object.
 * @return {Object} The JSON response message with a confirmation.
 */
function handleAppCommand(event, res) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  // Use appCommandType to detect message actions.
  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.message.text;

    // Return a response that includes details from the original message.
    return res.send({
      text: `Setting a reminder for this message: "${messageText}"`
    });
  }
}

Apps Script

/**
 * Responds to an APP_COMMAND interaction event in Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.message.text;

    // Return a response that includes details from the original message.
    return { "text": "Setting a reminder for message: " + messageText };
  }
}

Python

def handle_app_command(event):
    """Responds to an APP_COMMAND interaction event from Google Chat.

    Args:
        event (dict): The interaction event from Google Chat.

    Returns:
        dict: The JSON response message with a confirmation.
    """
    # Collect the command ID and type from the event metadata.
    metadata = event.get('appCommandMetadata', {})
    if metadata.get('appCommandType') == 'MESSAGE_ACTION' and \
       metadata.get('appCommandId') == REMIND_ME_COMMAND_ID:

        # Message actions can access the context of the message they were
        # invoked on, such as the text or sender of that message.
        message_text = event.get('message', {}).get('text')

        # Return a response that includes details from the original message.
        return {
            "text": f'Setting a reminder for message: "{message_text}"'
        }

Java

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param event The interaction event from Google Chat.
 * @param response The HTTP response object.
 */
void handleAppCommand(JsonObject event, HttpResponse response) throws Exception {
  // Collect the command ID and type from the event metadata.
  JsonObject metadata = event.getAsJsonObject("appCommandMetadata");
  String appCommandType = metadata.get("appCommandType").getAsString();

  if (appCommandType.equals("MESSAGE_ACTION")) {
    int commandId = metadata.get("appCommandId").getAsInt();
    if (commandId == REMIND_ME_COMMAND_ID) {
      // Message actions can access the context of the message they were
      // invoked on, such as the text or sender of that message.
      String messageText = event.getAsJsonObject("message").get("text").getAsString();

      // Return a response that includes details from the original message.
      JsonObject responseMessage = new JsonObject();
      responseMessage.addProperty("text", "Setting a reminder for message: " + messageText);
      response.getWriter().write(responseMessage.toString());
    }
  }
}

REMIND_ME_COMMAND_ID は、Google Cloud コンソールでコマンドを構成したときに指定したコマンド ID に置き換えます。

コマンドをテストする

コマンドとコードをテストするには、 Google Chat アプリのインタラクティブ機能をテストするをご覧ください。

Chat UI でコマンドをテストして使用する方法については、 Google Chat でアプリを使用する（Google Chat ヘルプドキュメント）をご覧ください。

Google Chat アプリのコマンドに応答する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Chat アプリのコマンドの種類

前提条件

Node.js

Apps Script

Python

Java

コマンドを設定する

コマンドの名前と説明を入力する

コマンドに名前を付けるには:

コマンドを説明するには:

Google Cloud コンソールでコマンドを構成する

コマンドに応答する

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

Node.js

Apps Script

Python

Java

クイック コマンドに応答する

Node.js

Apps Script

Python

Java

メッセージ操作に応答する

Node.js

Apps Script

Python

Java

コマンドをテストする

関連トピック

Google Chat アプリのコマンドに応答する

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

クイックコマンドに応答する