Gmail の操作

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 はこのレスポンス オブジェクトを使用して下書き作成ウィンドウを開き、入力します。

詳細と例については、下書きメッセージを作成するをご覧ください。