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 はこのレスポンス オブジェクトを使用して、下書き作成ウィンドウを開いて入力します。
詳細と例については、 下書きメッセージを作成するをご覧ください。