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