Action オブジェクトを使用すると、Google Workspace アドオンにインタラクティブな動作を組み込むことができます。アドオン UI のウィジェット（ボタンなど）をユーザーが操作したときに何が起こるかを定義します。
アクションは、ウィジェット ハンドラ関数を使用して特定のウィジェットに関連付けられます。この関数は、アクションをトリガーする条件も定義します。トリガーされると、アクションは指定されたコールバック関数を実行します。コールバック関数には、ユーザーのクライアントサイドの操作に関する情報を含むイベント オブジェクトが渡されます。コールバック関数を実装し、特定のレスポンス オブジェクトを返すようにする必要があります。
たとえば、クリックすると新しいカードを作成して表示するボタンが必要だとします。これを行うには、新しいボタン ウィジェットを作成し、ボタン ウィジェット ハンドラ関数 setOnClickAction(action) を使用してカード構築 Action を設定する必要があります。定義する Action は、ボタンがクリックされたときに実行される Apps Script コールバック関数を指定します。この場合、コールバック関数を実装して必要なカードを作成し、ActionResponse オブジェクトを返します。レスポンス オブジェクトは、コールバック関数が作成したカードを表示するようアドオンに指示します。
このページでは、アドオンに含めることができる Gmail 固有のウィジェット アクションについて説明します。
Gmail の操作
Gmail を拡張する Google Workspace アドオンには、下書きメッセージを作成するための Gmail 固有のウィジェット アクションを追加できます。このアクションでは、関連付けられたアクションのコールバック関数が、特殊なレスポンス オブジェクトを返す必要があります。
| 試行されたアクション | コールバック関数は |
|---|---|
| 下書きメッセージを作成する | ComposeActionResponse |
これらのウィジェット アクションとレスポンス オブジェクトを使用するには、Google Workspace アドオンのマニフェストに https://www.googleapis.com/auth/gmail.addons.current.action.compose
スコープを含める必要があります。
メッセージを作成する
Gmail を拡張するアドオンは、操作時に Gmail で下書きメッセージ（新規メッセージまたは返信）を生成するウィジェットを定義できます。そのためには、トリガー ウィジェットを ComposeActionResponse オブジェクトを返すコールバック関数に関連付けます。コールバック関数の実行が完了すると、Gmail はこのレスポンス オブジェクトを使用して、下書きの作成ウィンドウを開き、入力します。
詳細と例については、下書きメッセージを作成するをご覧ください。