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

ユーザーの操作を受信して応答する

このページでは、Google Chat アプリが Google Chat でユーザーインタラクションを受信して応答する方法について説明します。

Chat 用アプリのインタラクティブなインターフェースを構築するには、次のコンポーネントを使用します。

トリガー: Google Chat ユーザーが Chat 用アプリを呼び出す方法（スペースへの追加、メッセージの送信など）。
イベントオブジェクト: Chat 用アプリがトリガーまたは UI インタラクションから受信するデータ。
アクション: Chat 用アプリがインタラクションに応答する方法（メッセージの送信、カードベースのユーザーインターフェースの返却など）。

Chat 用アプリが「スペースに追加」トリガーからイベントオブジェクトを受信する — **図 1**: ユーザーがスペースに Chat 用アプリを追加すると、**Added to space** トリガーが起動し、イベントオブジェクトが送信されます。メッセージで応答するには、Chat 用アプリがイベントオブジェクトを処理し、メッセージを作成するアクションを返します。

Chat 用アプリは、次の方法でインターフェースを構築して表示できます。

メッセージ。テキスト、静的カードまたはインタラクティブカード、アクセサリーボタンを含めることができます。
Chat アプリとの 1 対 1 のダイレクトメッセージの [ホーム] タブに表示されるホームページ（アプリホーム）。
ダイアログ。新しいウィンドウで開くカードで、通常はユーザーに情報の送信を促します。
リンクプレビュー。外部サービスに関する情報をプレビューするカードです。

前提条件

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。
Google Cloud プロジェクトを作成します。
OAuth 同意画面を構成する。
Google Chat API を有効にして構成する。

ユーザーインタラクションの仕組み

ユーザーが Chat 用アプリを操作すると、Google Chat は構成済みのトリガーを呼び出し、Chat 用アプリのエンドポイントまたは関数にイベントオブジェクトを送信します。Chat アプリはイベントオブジェクトを処理し、30 秒以内にアクションを同期的に返すか、Chat API を使用して非同期的に応答できます。

次の図は、Google Chat 用アプリがユーザーインタラクションを処理して応答する方法を示しています。

Google Chat アプリがユーザーインタラクションを処理する仕組みのアーキテクチャ。

トリガー

トリガーは、ユーザーが Chat UI を使用して Chat 用アプリを呼び出す特定の方法です。たとえば、@メンションやアプリコマンドを使用します。

次の表に、Chat トリガー、説明、Chat アプリの一般的な応答を示します。

トリガー	説明	一般的な回答
スペースへの追加	ユーザーがスペースに Chat アプリを追加するか、Google Workspace 管理者が組織内のユーザーのダイレクトメッセージスペースに Chat アプリをインストールします。管理者がインストールした Chat 用アプリについて詳しくは、Google Workspace 管理者用ヘルプドキュメントのドメインに Marketplace アプリをインストールするをご覧ください。	Chat 用アプリは、その機能とスペース内のユーザーがアプリを操作する方法を説明するオンボーディングメッセージを送信します。
メッセージ	ユーザーが次のいずれかの方法でメッセージ内の Chat 用アプリを操作します。 Chat アプリを使用して、ダイレクトメッセージ（DM）スペースにメッセージを送信します。任意のタイプのスペースで Chat 用アプリに @メンションする。リンクプレビューの URL パターンに一致するリンクを含むメッセージを送信します。 `selectionInput` ウィジェットの複数選択メニューにテキストを入力します。	Chat 用アプリは、メッセージの内容に基づいて応答します。たとえば、Chat アプリはメッセージで返信したり、リンクプレビューカードを添付したり、複数選択メニューでアイテムを提案したりします。
スペースからの削除	ユーザーがスペースから Chat 用アプリを削除するか、Google Workspace 管理者が組織内のユーザーの Chat 用アプリをアンインストールします。管理者がインストールした Chat 用アプリをユーザーが削除することはできません。ユーザーが以前に Chat 用アプリをインストールしていた場合、Google Workspace 管理者がアンインストールしようとしても、Chat 用アプリはインストールされたままになります。	Chat 用アプリは、スペースに設定されている受信通知を削除し（ウェブフックの削除など）、内部ストレージをクリアします。Chat 用アプリはスペースのメンバーではなくなったため、このトリガーにメッセージで応答することはできません。
アプリコマンド	ユーザーが Chat アプリのコマンド（スラッシュコマンド、クイックコマンド、メッセージアクションなど）を呼び出します。	Chat 用アプリがコマンドに応答します。たとえば、メッセージで返信したり、ダイアログを開いたりします。
アプリのホーム	ユーザーが Chat アプリとの 1 対 1 のダイレクトメッセージ（DM）スペースで [ホーム] タブを開くか、ホームページカードのウィジェットを操作します。	Chat 用アプリは、ホームページカードをプッシュする（`pushCard`）か、表示されているホームページカードを更新する（`updateCard`）`RenderActions` オブジェクトを返します。

これらのトリガーのエンドポイントまたはコールバック関数は、Google Cloud コンソールの Chat API の [構成] ページで構成します。手順については、Google Chat API を構成するをご覧ください。

スタータープロンプトを構成する

スタータープロンプトは、ユーザーがアプリとの空の 1 対 1 のダイレクトメッセージを開いたときに、Chat アプリの機能を検出するのに役立ちます。スタータープロンプトは最大 3 つ構成できます。

スタータープロンプトを追加して構成するには:

Google Cloud コンソールで、Chat API の [構成] ページに移動します。

[Chat API の構成] ページに移動
[インタラクティブ機能] で [スタータープロンプト] を見つけ、[プロンプトを追加] をクリックします。
[Rank (1-3)] フィールドに、1 から 3 までの数値を入力して、表示順を指定します。
[タイプを選択] で、プロンプトの動作を選択します。
- テキストプロンプト: ユーザーがプロンプトチップをクリックすると、事前定義されたテキストが入力バーに入力されます。
- コマンドプロンプト: クリックすると、登録済みのスラッシュコマンドまたはクイックコマンドが実行されます。追加の引数が必要なコマンドは選択できません。
選択したタイプに基づいてプロンプトを構成します。
- [テキストプロンプト] を選択した場合:
  1. [タイトル] に、チップに表示されるプロンプトのタイトルを入力します（最大 30 文字）。
  2. [プロンプトテキスト] に、入力バーに表示されるテキストを入力します（最大 60 文字）。
  3. 省略可: 他の言語のユーザー向けに、ローカライズされたタイトルとテキストを追加します。
  4. [ローカライズされたプロンプト] で、[言語を追加] をクリックします。
  5. [言語] で、プルダウンからサポートされている言語を選択します。
  6. [ローカライズされたタイトル] に、ローカライズされたタイトルを入力します（30 文字以内）。
  7. [ローカライズされたプロンプトテキスト] に、ローカライズされたプロンプトテキスト（最大 60 文字）を入力します。
  8. 必要に応じて、この操作を繰り返して言語を追加します。
- [コマンドプロンプト] を選択した場合:
  1. [スラッシュコマンド / クイックコマンド] で、プルダウンからコマンドを選択します。
[完了] をクリックし、ページの下部にある [保存] をクリックします。

サービスへの HTTP 呼び出しの再試行を処理する

サービスへの HTTPS リクエストが失敗した場合（タイムアウト、一時的なネットワーク障害、2xx 以外の HTTPS ステータスコードなど）、Google Chat は数分以内に数回配信を再試行することがあります（ただし、これは保証されていません）。そのため、状況によっては、Chat 用アプリが同じイベントを複数回受信することがあります。リクエストが正常に完了しても、無効なレスポンスペイロードが返された場合、Google Chat はリクエストを再試行しません。

イベントオブジェクト

Chat 用アプリは、Chat トリガーが実行されたとき、または Chat ユーザーが Chat 用アプリの UI を操作したとき（ボタンのクリックやダイアログの送信など）にイベントオブジェクトを受け取ります。イベントオブジェクトを使用すると、インタラクションデータを使用して UI を応答または更新できます。

2025 年に、Google Chat アプリはアドオンイベントをサポートするように拡張されました。これは、2025 年 7 月以降、新しい Chat アプリのデフォルトになっています。Chat のドキュメント全体で、アドオンイベントはガイドとコードサンプルに示されている標準のイベントタイプです。Chat イベント（Google Workspace アドオンではない Chat アプリの場合）のドキュメントは、折りたたみ可能なセクション（アドオンではない Chat アプリ: インタラクションイベントを受信して応答するなど）に分かれています。

イベントとレスポンスのタイプを決定する

Chat アプリがイベントオブジェクトを受信すると、ペイロードの構造と応答方法は、Chat アプリが Google Workspace アドオンとして構成されているかどうかによって異なります。

アプリが受信するイベントオブジェクトの種類と、アプリがどのように応答する必要があるかを確認するには、次の表を使用してアプリの構成を確認します。

アプリの種類	アドオンイベントを受信する（2025 年 7 月以降に作成された新しいアプリのデフォルト）	Chat イベントを受信する（2025 年 7 月より前のデフォルト）
Apps Script アプリマニフェストファイル（`appsscript.json`）を確認します。	`chat` オブジェクトは `addOns` 内で構成されます。 `{ "addOns": { "chat": {} } }`	`chat` オブジェクトは、マニフェストのルートで構成されます。 `{ "chat": {} }`
その他のアプリ Google Chat API の構成ページを確認する	[Build this Chat app as a Google Workspace add-on] チェックボックスがオンになっている。	[この Chat アプリを Google Workspace アドオンとして構築する] チェックボックスがオフになっている。
ドキュメントの入手先	ガイドとコードサンプル全体イベントリファレンスドキュメント: アドオンイベントオブジェクト	折りたたまれたセクション（例: アドオンではない Chat 用アプリ: インタラクションイベントを受信して応答する）イベントリファレンスドキュメント: Chat API インタラクションイベント
対応方法	`DataActions` や `RenderActions` などのアクションを返します。アクションで応答する方法を確認する	`Message` リソースを返します。メッセージで返信する方法を確認する

イベントオブジェクトのペイロード

各アドオンイベントオブジェクトには、ホストとプラットフォームの詳細（hostApp: "CHAT"、clientPlatform、userLocale、userTimezone、parameters、formInputs）を含む commonEventObject と、Chat 固有のコンテキストを含む chat オブジェクトが含まれます。

アプリホーム トリガー（ユーザーが Chat アプリとの 1 対 1 のダイレクトメッセージで [ホーム] タブを開いたとき）の場合、chat オブジェクトには、ユニオン payload フィールドなしで chat.user と chat.eventTime が含まれます。ユーザーがホームページカードのボタンをクリックすると、イベントオブジェクトには commonEventObject.parameters（およびカードにフォーム入力が含まれている場合は commonEventObject.formInputs）とともに chat.buttonClickedPayload が含まれます。
スペースとメッセージのインタラクション（スペースに追加、メッセージ、スペースから削除、アプリコマンド、ボタンとウィジェットのインタラクション）の場合、chat オブジェクトには chat.user、chat.space、chat.eventTime、対応するインタラクションペイロードが含まれます。
- messagePayload: ユーザーがメッセージを送信したときの space、message、configCompleteRedirectUri が含まれます。
- addedToSpacePayload: Chat アプリがスペースに追加されたときの space、interactionAdd、configCompleteRedirectUri が含まれます。
- removedFromSpacePayload: Chat 用アプリがスペースから削除されたときの space が含まれます。
- buttonClickedPayload: ユーザーがカードまたはダイアログのボタンをクリックしたときに、space、message、isDialogEvent、dialogEventType が含まれます。
- widgetUpdatedPayload: ユーザーがウィジェットを操作したときの space が含まれます。たとえば、外部データソースを含む複数選択メニューに入力した場合などです。
- appCommandPayload: ユーザーがアプリコマンドを呼び出したときの space、message、appCommandMetadata、isDialogEvent、dialogEventType、configCompleteRedirectUri が含まれます。

Chat やその他の Google Workspace アプリケーション内のアドオンイベントオブジェクトについては、イベントオブジェクトをご覧ください。

回答を提示する

このセクションでは、Chat 用アプリがアクションを使用してユーザーインタラクションに同期的に応答する方法について説明します。

アクションで応答するには、Chat 用アプリは 30 秒以内に応答する必要があります。また、応答は、インタラクションが発生したスペースに適用される必要があります。これらの同期レスポンスには認証は必要ありません。Chat アプリが 30 秒以上かかる場合や、スペース外で動作する必要がある場合は、認証を設定し、Google Chat API を使用して非同期で応答します。

ユーザー操作に同期的に応答するには、Chat 用アプリが受信イベントオブジェクトを処理し、次のいずれかの JSON オブジェクトを返します。

DataActions: chatDataActionMarkup を使用して、チャットメッセージ（CreateMessageAction、UpdateMessageAction）を作成または更新するか、リンクプレビュー（UpdateInlinePreviewAction）を添付します。
RenderActions: ホームページまたはダイアログ（pushCard、updateCard、endNavigation: "CLOSE_DIALOG"）を作成、更新、または閉じます。または、複数選択メニュー（modifyCard）に動的な入力候補を提供します。
AuthorizationError: 基本的な承認カード（basic_authorization_prompt）を使用して、外部サービスへのログインまたは認証をユーザーに求めます。

次の表に、Chat 用アプリがアクションで応答する方法を示します。Chat 用アプリは、JSON オブジェクトを直接返すか、Apps Script の AddOnResponseService と CardService を使用してレスポンスを構築できます。

Chat アプリのレスポンス	返すために必要なアクション（JSON）	返品に必要な対応（Apps Script）
メッセージを送信する、またはメッセージを更新する。	`DataActions`（`createMessageAction` または `updateMessageAction`）	`DataActionsResponse`
Chat ユーザーがスペースで送信したメッセージ内のリンクをプレビューする。	`DataActions`（`updateInlinePreviewAction`）	`DataActionsResponse`
ダイレクトメッセージの [ホーム] タブでホームページをレンダリングまたは更新する。	`RenderActions`（`pushCard` または `updateCard`）	`ActionResponse`
ダイアログを開く、更新する、閉じる。	`RenderActions`（`pushCard`、`updateCard`、または `endNavigation: "CLOSE_DIALOG"`）	`ActionResponse`
カードまたはダイアログから情報を収集するには、ユーザーが複数選択メニューに入力した内容に基づいて選択項目を提案します。	`RenderActions`（`modifyCard`）	`ActionResponse`
外部サービスの構成または承認をリクエストします。	`AuthorizationError`（`basic_authorization_prompt`）	`AuthorizationException`

メッセージで応答

Chat 用アプリは、次のいずれかのトリガーまたはインタラクションに対してメッセージを返すことができます。

メッセージ トリガー。ユーザーが Chat 用アプリに @メンションまたはダイレクトメッセージを送信した場合など。
スペースに追加トリガー。たとえば、ユーザーが Google Workspace Marketplace から Chat 用アプリをインストールしたり、スペースに追加したりした場合。
ユーザーがスラッシュコマンドやクイックコマンドを呼び出したときなどのアプリコマンド トリガー。
メッセージまたはダイアログのカードのボタンクリック。たとえば、ユーザーが情報を入力して [送信] をクリックしたときです。

Chat 用アプリは、メッセージに次のいずれかを含めることができます。

ハイパーリンク、@メンション、絵文字を含むテキスト。メッセージの書式を設定するをご覧ください。
1 つ以上のカード。メッセージに表示されるか、ダイアログとして新しいウィンドウで開きます。Google Chat アプリ用のカードを作成するをご覧ください。
1 つ以上のアクセサリーウィジェット。メッセージ内のテキストまたはカードの後に表示されるボタンです。

メッセージで返信するには、CreateMessageAction オブジェクトを含む DataActions を返します。

{
  "hostAppDataAction": {
    "chatDataAction": {
      "createMessageAction": {
        "message": <var>MESSAGE</var>
      }
    }
  }
}

MESSAGE は、Chat API の Message リソースに置き換えます。

次の例では、Chat 用アプリがスペースに追加されるたびに、DataActions を使用して [スペースに追加] トリガーに応答することで、オンボーディングテキストメッセージを作成して送信します。

Node.js

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} req The request object from Google Chat.
 * @param {Object} res The response object from the Chat app.
 */
exports.cymbalApp = function cymbalApp(req, res) {
  const chatEvent = req.body.chat;
  // Send an onboarding message when added to a Chat space
  if (chatEvent.addedToSpacePayload) {
    res.json({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
      text: 'Hi, Cymbal at your service. I help you manage your calendar ' +
        'from Google Chat. Take a look at your schedule today by typing ' +
        '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. ' +
        'To learn what else I can do, type `/help`.'
    }}}}});
  }
};

Python

from flask import Flask, request, json
app = Flask(__name__)

@app.route('/', methods=['POST'])
def cymbal_app():
  """Sends an onboarding message when the Chat app is added to a space.

  Returns:
    Mapping[str, Any]: The response object from the Chat app.
  """
  chat_event = request.get_json()["chat"]
  if "addedToSpacePayload" in chat_event:
    return json.jsonify({ "hostAppDataAction": { "chatDataAction": {
      "createMessageAction": { "message": {
        "text": 'Hi, Cymbal at your service. I help you manage your calendar ' +
        'from Google Chat. Take a look at your schedule today by typing ' +
        '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. ' +
        'To learn what else I can do, type `/help`.'
      }}
    }}})

Java

@SpringBootApplication
@RestController
public class App {
  public static void main(String[] args) {
    SpringApplication.run(App.class, args);
  }

  /*
   * Sends an onboarding message when the Chat app is added to a space.
   *
   * @return The response object from the Chat app.
   */
  @PostMapping("/")
  @ResponseBody
  public GenericJson onEvent(@RequestBody JsonNode event) throws Exception {
    JsonNode chatEvent = event.at("/chat");
    if (!chatEvent.at("/addedToSpacePayload").isEmpty()) {
      return new GenericJson() { {
        put("hostAppDataAction", new GenericJson() { {
          put("chatDataAction", new GenericJson() { {
            put("createMessageAction", new GenericJson() { {
              put("message", new Message().setText(
                "Hi, Cymbal at your service. I help you manage your calendar " +
                "from Google Chat. Take a look at your schedule today by typing " +
                "`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. " +
                "To learn what else I can do, type `/help`."
              ));
            } });
          } });
        } });
      } };
    }
    return new GenericJson();
  }
}

Apps Script

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Google Chat.
 * @return {Object} Response from the Chat app.
 */
function onAddedToSpace(event) {
  return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
    text: 'Hi, Cymbal at your service. I help you manage your calendar ' +
          'from Google Chat. Take a look at your schedule today by typing ' +
          '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. ' +
          'To learn what else I can do, type `/help`.'
  }}}}};
}

このコードサンプルは、次のテキストメッセージを返します。

オンボーディングメッセージの例。

メッセージを更新する

Chat 用アプリは、送信したメッセージを更新することもできます。たとえば、Chat 用アプリは、ユーザーがダイアログを送信したり、メッセージ内のカードのボタンをクリックしたりした後に、メッセージを更新できます。

インタラクションに応じて Chat アプリのメッセージを更新するには、UpdateMessageAction を含む DataActions を返します。

{
  "hostAppDataAction": {
    "chatDataAction": {
      "updateMessageAction": {
        "message": <var>MESSAGE</var>
      }
    }
  }
}

MESSAGE は、Chat API の Message リソースに置き換えます。

Chat 用アプリは、updateInlinePreviewAction を使用して、ユーザーが送信したメッセージを更新し、リンクプレビューカードを添付することもできます。詳細については、リンクをプレビューするをご覧ください。

Google Chat API を使用して非同期で応答する

Chat 用アプリは、アクションを同期的に返すのではなく、Google Chat API を呼び出してインタラクションに応答したり、プロアクティブメッセージを送信したりする必要がある場合があります。たとえば、Chat 用アプリは、次のいずれかを行うために Google Chat API を呼び出す必要があります。

30 秒後にインタラクションに応答する（長時間実行タスクの完了後など）。
スケジュールに沿ってメッセージを送信したり、外部リソースの変更に関する通知を送信したりします。
やり取りが行われたスペースの外でタスクを実行する。
スペースの一覧表示やスペースへのメンバーの追加など、同期アクションとして利用できないタスクを Chat で実行する。
Chat ユーザーに代わってタスクを実行する（ユーザー認証が必要）。

30 秒後にインタラクションに応答する場合、Chat アプリが応答していないというユーザー向けのエラーメッセージが表示されないようにするには、空のレスポンスを返すことで、30 秒以内にイベントオブジェクトの受信を確認する必要があります。

Node.js

async function onEvent(req, res) {
  // Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return res.send({});
};

Python

def on_event(event) -> dict:
  # Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return {}

Java

public String onEvent(JsonNode event) {
  // Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return "{}";
}

Apps Script

function onEvent(event) {
  // Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return null;
}

Chat API を使用してメッセージを送信するには、認証を設定して spaces.messages.create メソッドを呼び出します。手順については、メッセージを送信するをご覧ください。その他の Chat API メソッドの使用方法については、Chat API の概要をご覧ください。

アドオンではない Chat 用アプリ: ユーザーインタラクションを受け取って応答する

Google Workspace アドオンではない Chat 用アプリは、Google Workspace アドオンのイベントオブジェクト（EventObject）ではなく、Chat API のインタラクションイベント（Event）を受け取り、アクションではなく Message リソースを返して応答します。

アドオンではない Chat アプリを Google Workspace アドオンフレームワークにアップグレードするには、Google Chat アプリを Google Workspace アドオンに変換するをご覧ください。

インタラクションイベントの種類

ユーザー操作の種類ごとに、Google Chat はアドオンではない Chat 用アプリに Event オブジェクトを送信します。このオブジェクトのタイプは eventType フィールドで表されます。

ユーザーの操作	`eventType`	アドオンではない Chat 用アプリからの一般的なレスポンス
ユーザーが Chat 用アプリにメッセージを送信します。たとえば、Chat 用アプリに @ メンションを付けたり、スラッシュコマンドを使用したりします。	`MESSAGE`	Chat 用アプリは、メッセージの内容に基づいて応答します。たとえば、チャットアプリは、スラッシュコマンド `/about` に、チャットアプリが実行できるタスクを説明するメッセージを返します。
ユーザーが Chat アプリをスペースに追加した。	`ADDED_TO_SPACE`	Chat 用アプリは、その機能と、スペース内のユーザーがどのように操作できるかを説明するオンボーディングメッセージを送信します。
ユーザーがスペースから Chat 用アプリを削除した。	`REMOVED_FROM_SPACE`	Chat 用アプリは、スペースに構成されている受信通知を削除し（ウェブフックの削除など）、内部ストレージをクリアします。
ユーザーが Chat アプリのメッセージ、ダイアログ、またはホームページのカードのボタンをクリックします。	`CARD_CLICKED`	Chat 用アプリは、ユーザーが送信したデータを処理して保存するか、別のカードを返します。
ユーザーが 1 対 1 のメッセージで [ホーム] タブをクリックして、Chat 用アプリのホームページを開きます。	`APP_HOME`	Chat アプリは、ホームページから静的カードまたはインタラクティブカードを返します。
ユーザーが Chat アプリのホームページからフォームを送信します。	`SUBMIT_FORM`	Chat 用アプリは、ユーザーが送信したデータを処理して保存するか、別のカードを返します。
ユーザーがクイックコマンドを使用してコマンドを呼び出します。	`APP_COMMAND`	Chat 用アプリは、呼び出されたコマンドに基づいて応答します。たとえば、Chat 用アプリは、About コマンドに対して、Chat 用アプリが実行できるタスクを説明するメッセージを返します。

サポートされているすべてのインタラクションイベントと JSON ペイロードの例については、Chat 用アプリのインタラクションイベントの種類と EventType リファレンスドキュメントをご覧ください。

ダイアログからのインタラクションイベント

アドオンではない Chat アプリがダイアログを開くと、インタラクションイベントには、レスポンスの処理に使用できる次の追加情報が含まれます。

isDialogEvent フィールドは true に設定されています。
DialogEventType（REQUEST_DIALOG、SUBMIT_DIALOG、CANCEL_DIALOG）は、インタラクションによってダイアログが開くか、ダイアログから情報が送信されるか、ダイアログが閉じるかを明確にします。

アドオンではない Chat 用アプリを構成して、インタラクションイベントを受信する

Google Cloud コンソールで、Chat API の [構成] ページに移動します。

[Chat API の構成] ページに移動
[インタラクティブ機能] で、[この Chat アプリを Google Workspace アドオンとしてビルドする] をオフにし、[機能]、単一の [接続設定] エンドポイント（HTTP エンドポイント URL、Apps Script、Cloud Pub/Sub トピック名、Dialogflow）、[コマンド]、[スタータープロンプト]、[リンクプレビュー]、[公開設定] を構成します。
[保存] をクリックします。

アドオンではない Chat 用アプリでメッセージを返信する

アドオンではない Chat 用アプリで同期的に応答するには、Message オブジェクトを直接返します。次の例では、ADDED_TO_SPACE インタラクションイベントにテキストメッセージで応答します。

Node.js

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} req The event object from Chat API.
 * @param {Object} res The response object from the Chat app.
 */
exports.cymbalApp = function cymbalApp(req, res) {
  // Send an onboarding message when added to a Chat space
  if (req.body.type === 'ADDED_TO_SPACE') {
    res.json({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar ' +
        'from Google Chat. Take a look at your schedule today by typing ' +
        '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To ' +
        'learn what else I can do, type `/help`.'
    });
  }
};

Python

from flask import Flask, request, json
app = Flask(__name__)

@app.route('/', methods=['POST'])
def cymbal_app():
  """Sends an onboarding message when the Chat app is added to a space.

  Returns:
    Mapping[str, Any]: The response object from the Chat app.
  """
  event = request.get_json()
  if event['type'] == 'ADDED_TO_SPACE':
    return json.jsonify({
      'text': 'Hi, Cymbal at your service. I help you manage your calendar ' +
      'from Google Chat. Take a look at your schedule today by typing ' +
      '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To ' +
      'learn what else I can do, type `/help`.'
    })
  return json.jsonify({})

Java

@SpringBootApplication
@RestController
public class App {
  public static void main(String[] args) {
    SpringApplication.run(App.class, args);
  }

  /*
   * Sends an onboarding message when the Chat app is added to a space.
   *
   * @return The response object from the Chat app.
   */
  @PostMapping("/")
  @ResponseBody
  public Message onEvent(@RequestBody JsonNode event) {
    switch (event.get("type").asText()) {
      case "ADDED_TO_SPACE":
        return new Message().setText(
          "Hi, Cymbal at your service. I help you manage your calendar " +
          "from Google Chat. Take a look at your schedule today by typing " +
          "`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. " +
          "To learn what else I can do, type `/help`.");
      default:
        return new Message();
    }
  }
}

Apps Script

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app.
 */
function onAddToSpace(event) {
  return {
    'text': 'Hi, Cymbal at your service. I help you manage your calendar ' +
      'from Google Chat. Take a look at your schedule today by typing ' +
      '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn ' +
      'what else I can do, type `/help`.'
  };
}

ユーザーの操作を受信して応答する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

前提条件

ユーザー インタラクションの仕組み

トリガー

スターター プロンプトを構成する

サービスへの HTTP 呼び出しの再試行を処理する

イベント オブジェクト

イベントとレスポンスのタイプを決定する

イベント オブジェクトのペイロード

回答を提示する

メッセージで応答

Node.js

Python

Java

Apps Script

メッセージを更新する

Google Chat API を使用して非同期で応答する

Node.js

Python

Java

Apps Script

関連トピック

アドオンではない Chat 用アプリ: ユーザー インタラクションを受け取って応答する

インタラクション イベントの種類

ダイアログからのインタラクション イベント

アドオンではない Chat 用アプリを構成して、インタラクション イベントを受信する

アドオンではない Chat 用アプリでメッセージを返信する

Node.js

Python

Java

Apps Script

ユーザーの操作を受信して応答する

ユーザーインタラクションの仕組み

スタータープロンプトを構成する

イベントオブジェクト

イベントオブジェクトのペイロード

アドオンではない Chat 用アプリ: ユーザーインタラクションを受け取って応答する

インタラクションイベントの種類

ダイアログからのインタラクションイベント

アドオンではない Chat 用アプリを構成して、インタラクションイベントを受信する