Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

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

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

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

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

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

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

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

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

追加の入力を待たずに Chat 用アプリがユーザーにすぐに返信できる場合は、クイックコマンドを作成します。たとえば、ランダムな画像という名前のクイックコマンドを作成して、画像ですぐに応答させることができます。
メッセージアクション: ユーザーは、メッセージにカーソルを合わせてその他メニューをクリックすることで、メッセージアクションを使用します。コマンドを使用するには、その他メニューを開き、メニューからコマンドを選択します。

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

次の画像は、ユーザーがスラッシュコマンドとクイックコマンドのメニュー、メッセージアクションをどのように見つけるかを示しています。

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

ユーザーがメッセージアクションを含むメッセージのコンテキストメニューを見つけます。 — ユーザーは、[リマインダー] メッセージアクションを含むメッセージコンテキストメニューを見つけます。

前提条件

HTTP

ユーザーインタラクションを受け取って応答する Google Chat 用アプリ。作成するには、HTTP クイックスタートを完了します。

Apps Script

ユーザーインタラクションを受け取って応答する 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 コンソールでコマンドを構成する

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

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

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

Google Chat API ページに移動
[構成] をクリックします。
[接続設定] で、[トリガー] に移動して、エンドポイントの詳細を指定します。コマンドに応答するには、次のセクションでこのトリガーを使用する必要があります。
1. HTTP エンドポイント URL: ここで、共通の HTTP エンドポイント URL を 1 つ指定できます。または、トリガーごとに異なる HTTP エンドポイントを使用するには、[アプリコマンド] フィールドでエンドポイントを直接指定します。
2. Apps Script: Apps Script のデプロイ ID を入力します。デフォルトでは、onAppCommand 関数が呼び出されます。別の Apps Script 関数を使用するには、[アプリコマンド] フィールドにカスタム関数名を指定します。
[コマンド] で、[コマンドを追加] をクリックします。
コマンドに関する次の情報を入力します。
1. コマンド ID: Chat 用アプリがコマンドを認識してレスポンスを返すために使用する 1 ～ 1,000 の数値。
2. 説明: コマンドの使用方法と形式を説明するテキスト。説明文は半角 50 文字（全角 25 文字）以内で指定できます。
3. コマンドの種類: [クイックコマンド]、[スラッシュコマンド]、[メッセージアクション] のいずれかを選択します。
4. コマンドの名前を指定します。
  - クイックコマンド名: ユーザーがメニューから選択してコマンドを呼び出す表示名。半角 50 文字以内で、特殊文字を含めることができます。例: Remind me
  - スラッシュコマンド名: ユーザーがメッセージでコマンドを呼び出すために入力するテキスト。先頭はスラッシュにする必要があります。使用できるのはテキストのみで、最大 50 文字です。例: /remindMe
  - メッセージアクション名: ユーザーがメニューから選択してメッセージアクションを呼び出す表示名。半角 50 文字以内で、特殊文字を含めることができます。例: Remind me
省略可: 読み込み通知メッセージ: メッセージアクションの実行中にユーザーに表示するトースト通知メッセージ。ダイアログを開かないメッセージアクションでのみ使用できます。
省略可: Chat 用アプリがコマンドにダイアログで応答するようにするには、[ダイアログを開く] チェックボックスをオンにします。
[保存] をクリックします。

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

コマンドをスタータープロンプトにマッピングする

コマンドをスタータープロンプトとして表示すると、ユーザーが Chat 用アプリで 1 対 1 の空のダイレクトメッセージを開始したときに、インタラクティブチップとして表示されます。

コマンドをスタータープロンプトにマッピングするには:

コマンドに追加のカスタム引数が必要ないことを確認します（引数なしまたは基本引数のみのコマンドがスタータープロンプトとしてサポートされています）。
Google Cloud コンソールで、Chat API の [構成] ページに移動します。
[インタラクティブ機能] > [開始プロンプト] で、[プロンプトを追加] をクリックします。
表示順序のランク（1 ～ 3）を設定します。
[タイプの選択] で [コマンドプロンプト] を選択し、プルダウンからコマンドを選択します。
[完了]、[保存] の順にクリックします。

コマンドに応答する

ユーザーがコマンドを使用すると、Chat 用アプリはイベントオブジェクトを受け取ります。イベントペイロード（event.chat.appCommandPayload）には、呼び出されたコマンドの詳細（コマンド ID やコマンドタイプなど）を含む appCommandPayload オブジェクトが含まれています。これにより、適切なレスポンスを返すことができます。イベントオブジェクトは、アプリコマンド トリガーを構成したときに指定した HTTP エンドポイントまたは Apps Script 関数に送信されます。

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

スラッシュコマンドまたはクイックコマンドに応答する

次のコードは、スラッシュコマンド /about にテキストメッセージで応答する Chat 用アプリの例を示しています。スラッシュコマンドまたはクイックコマンドに応答するには、Chat 用アプリがアプリコマンド トリガーからのイベントオブジェクト（event.chat.appCommandPayload）を処理します。イベントオブジェクトのペイロードに一致するコマンド ID が含まれている場合、Chat 用アプリは createMessageAction（hostAppDataAction.chatDataAction.createMessageAction）オブジェクトを含むアクション DataActions を返します。

Node.js

node/chat/avatar-app/index.js

GitHub で表示

// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Handle requests from Google Workspace add on
 *
 * @param {Object} req Request sent by Google Chat
 * @param {Object} res Response to be sent back to Google Chat
 */
http('avatarApp', (req, res) => {
  const chatEvent = req.body.chat;
  let message;
  if (chatEvent.appCommandPayload) {
    message = handleAppCommand(chatEvent);
  } else {
    message = handleMessage(chatEvent);
  }
  res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: {
    message: message
  }}}});
});

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 * @return the response message object.
 */
function handleAppCommand(event) {
  switch (event.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return {
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/chat/avatar-app/main.py

GitHub で表示

# The ID of the slash command "/about".
# You must use the same ID in the Google Chat API configuration.
ABOUT_COMMAND_ID = 1

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
  """Handle requests from Google Workspace add on

  Args:
    flask.Request req: the request sent by Google Chat

  Returns:
    Mapping[str, Any]: the response to be sent back to Google Chat
  """
  chat_event = req.get_json(silent=True)["chat"]
  if chat_event and "appCommandPayload" in chat_event:
    message = handle_app_command(chat_event)
  else:
    message = handle_message(chat_event)
  return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
      "message": message
  }}}}

def handle_app_command(event: Mapping[str, Any]) -> Mapping[str, Any]:
  """Responds to an APP_COMMAND event in Google Chat.

  Args:
    Mapping[str, Any] event: the event object from Google Chat

  Returns:
    Mapping[str, Any]: the response message object.
  """
  if event["appCommandPayload"]["appCommandMetadata"]["appCommandId"] == ABOUT_COMMAND_ID:
    return {
      "text": "The Avatar app replies to Google Chat messages.",
    }
  return {}

Java

java/chat/avatar-app/src/main/java/com/google/chat/avatar/App.java

GitHub で表示

// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
private static final int ABOUT_COMMAND_ID = 1;

private static final Gson gson = new Gson();

/**
 * Handle requests from Google Workspace add on
 * 
 * @param request the request sent by Google Chat
 * @param response the response to be sent back to Google Chat
 */
@Override
public void service(HttpRequest request, HttpResponse response) throws Exception {
  JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);
  JsonObject chatEvent = event.getAsJsonObject("chat");
  Message message;
  if (chatEvent.has("appCommandPayload")) {
    message = handleAppCommand(chatEvent);
  } else {
    message = handleMessage(chatEvent);
  }
  JsonObject createMessageAction = new JsonObject();
  createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));
  JsonObject chatDataAction = new JsonObject();
  chatDataAction.add("createMessageAction", createMessageAction);
  JsonObject hostAppDataAction = new JsonObject();
  hostAppDataAction.add("chatDataAction", chatDataAction);
  JsonObject dataActions = new JsonObject();
  dataActions.add("hostAppDataAction", hostAppDataAction);
  response.getWriter().write(gson.toJson(dataActions));
}

/**
 * Handles an APP_COMMAND event in Google Chat.
 *
 * @param event the event object from Google Chat
 * @return the response message object.
 */
private Message handleAppCommand(JsonObject event) throws Exception {
  switch (event.getAsJsonObject("appCommandPayload")
    .getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt()) {
    case ABOUT_COMMAND_ID:
      return new Message()
        .setText("The Avatar app replies to Google Chat messages.");
    default:
      return null;
  }
}

Apps Script

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

GitHub で表示

// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {
  // Executes the app command logic based on ID.
  switch (event.chat.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        text: 'The Avatar app replies to Google Chat messages.'
      }}}}};
  }
}

このコードサンプルを使用するには、ABOUT_COMMAND_ID を Chat API でコマンドを構成したときに指定したコマンド ID に置き換えます。

メッセージアクションに応答する

次のコードは、メッセージアクション [Remind me] にテキストメッセージで返信する Chat 用アプリの例を示しています。メッセージアクションに応答するには、Chat 用アプリで アプリコマンド トリガーからのイベントオブジェクトを処理します。イベントオブジェクトのペイロードにメッセージアクションコマンド ID が含まれている場合、Chat 用アプリは createMessageAction オブジェクトを含むアクション DataActions を返します。

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 onAppCommand(event, res) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} =
    event.chat.appCommandPayload.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.chat.appCommandPayload.message.text;

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

Python

def on_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.
    payload = event.get('chat', {}).get('appCommandPayload', {})
    metadata = payload.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 = payload.get('message', {}).get('text')

        # Return a response that includes details from the original message.
        return {
            "hostAppDataAction": {
                "chatDataAction": {
                    "createMessageAction": {
                        "message": {
                            "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 onAppCommand(JsonObject event, HttpResponse response) throws Exception {
  // Collect the command ID and type from the event metadata.
  JsonObject payload = event.getAsJsonObject("chat").getAsJsonObject("appCommandPayload");
  JsonObject metadata = payload.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 = payload.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);

      JsonObject createMessageAction = new JsonObject();
      createMessageAction.add("message", responseMessage);

      JsonObject chatDataAction = new JsonObject();
      chatDataAction.add("createMessageAction", createMessageAction);

      JsonObject hostAppDataAction = new JsonObject();
      hostAppDataAction.add("chatDataAction", chatDataAction);

      JsonObject finalResponse = new JsonObject();
      finalResponse.add("hostAppDataAction", hostAppDataAction);

      response.getWriter().write(finalResponse.toString());
    }
  }
}

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.chat.appCommandPayload.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.chat.appCommandPayload.message.text;

    // Return a response that includes details from the original message.
    return CardService.newChatResponseBuilder()
        .setText("Setting a reminder for message: " + messageText)
        .build();
  }
}

このコードサンプルを使用するには、REMIND_ME_COMMAND_ID を Chat API でコマンドを構成したときに指定したコマンド ID に置き換えます。

コマンドをテストする

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

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

アドオンではない Chat 用アプリ: コマンドに応答する

次のドキュメントは、Google Workspace アドオンではない Chat 用アプリに適用されます。アドオンではない Chat 用アプリを移行するには、Google Chat 用アプリを Google Workspace アドオンに変換するをご覧ください。

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

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

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

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

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

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 に置き換えます。

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

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

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 に置き換えます。

メッセージアクションに応答する

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

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 用アプリのコマンドの種類

前提条件

HTTP

Apps Script

コマンドを設定する

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

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

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

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

コマンドをスターター プロンプトにマッピングする

コマンドに応答する

スラッシュ コマンドまたはクイック コマンドに応答する

Node.js

Python

Java

Apps Script

メッセージ アクションに応答する

Node.js

Python

Java

Apps Script

コマンドをテストする

関連トピック

アドオンではない Chat 用アプリ: コマンドに応答する

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

Node.js

Apps Script

Python

Java

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

Node.js

Apps Script

Python

Java

メッセージ アクションに応答する

Node.js

Apps Script

Python

Java

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

コマンドをスタータープロンプトにマッピングする

スラッシュコマンドまたはクイックコマンドに応答する

メッセージアクションに応答する

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

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

メッセージアクションに応答する