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