アドオンのアクション

アドオン アクションを使用すると、アドオンの ウィジェット: アクションを作成することで、ユーザーがアクションを選択または更新したときの動作を定義します。 作成します。

ほとんどの場合、 Action Apps Script のカードサービスによって提供されるオブジェクト。 各 Action は コールバック関数を作成するとします。コールバック関数を実装する ユーザーがウィジェットを操作したときに必要な手順を実行します。また、 Action をウィジェットにリンクする 適切なウィジェット ハンドラ関数を使用して、 どのようなインタラクションが Action コールバックを使用します。

Action でウィジェットを構成する 一般的なプロセスを使用します

1. Action オブジェクトを作成します。 このコールバック関数を指定して、 必要なパラメータとともに実行します。
2. 適切なウィジェット ハンドラ関数を呼び出す ウィジェットで Action 渡されます。
3. 必要な動作を実行するコールバック関数を実装します。

で確認できます。

注: Action と混同しないでください。 CardAction を含むオブジェクト 説明します。CardAction オブジェクト カードヘッダーのメニュー項目、Action オブジェクトで、UI の操作に対する応答を定義します。

ウィジェット ハンドラ関数

ウィジェットを特定の Action にリンクするには: 使用する場合は、ウィジェットを使用して 使用します。ハンドラ関数は、使用するインタラクションの種類を たとえば、ウィジェットをクリックしたり、テキスト フィールドを編集したりすると、 できます。ハンドラ関数は、UI で実行されるステップも定義します。 トリガーされます。

次の表に、ウィジェットのさまざまなハンドラタイプと、 使用するウィジェット:

ハンドラ関数	アクションをトリガー	該当するウィジェット	説明
setOnChangeAction()	ウィジェットの値が変わる	DatePicker DateTimePicker SelectionInput Switch TextInput TimePicker	Action を設定する ウィジェットがフォーカスを喪失したときに Apps Script 関数を実行します。 たとえばユーザーが入力テキストを入力し Enter キーを押したときなどです「 ハンドラが自動的に イベント オブジェクトを、その関数が呼び出す関数に追加するようにします。 このイベント オブジェクトに追加のパラメータ情報を挿入できます。 こともできます。
setOnClickAction()	ユーザーがウィジェットをクリックする	CardAction Image ImageButton DecoratedText TextButton	Action を設定する ユーザーがウィジェットをクリックしたときに Apps Script 関数を実行します。「 ハンドラが自動的に イベント オブジェクトを、その関数が呼び出す関数に追加するようにします。 このイベント オブジェクトには、オプションのパラメータ情報を挿入できます。
setComposeAction()	ユーザーがウィジェットをクリックする	CardAction Image ImageButton DecoratedText TextButton	Gmail 専用。次の値を設定します。 Action メールの下書きを作成し、その下書きを Gmail UI の作成ウィンドウ。下書きは新しいメッセージまたは Gmail で開いているメールに返信する。ハンドラが ドラフト作成コールバック関数では、 イベント オブジェクトをコールバック関数に渡します。 詳しくは、 メールの下書きを作成する をご覧ください。
setOnClickOpenLinkAction()	ユーザーがウィジェットをクリックする	CardAction Image ImageButton DecoratedText TextButton	Action を設定する ユーザーがウィジェットをクリックしたときに URL が開きます。このハンドラは次の場合に URL を構築するか、リンクの前にその他のアクションを行う必要があります。 開くそれ以外の場合は、通常は setOpenLink() を使用する方が簡単です。 URL は新しいウィンドウで開くことができます。閉じると、 アドオンを再読み込みする UI。
setOpenLink()	ユーザーがウィジェットをクリックする	CardAction Image ImageButton DecoratedText TextButton	ユーザーがウィジェットをクリックしたときに URL を直接開く。使用する URL がわかっていて、それを開くだけでよい場合です。それ以外の場合は次を使用 setOnClickOpenLinkAction()。 URL は新しいウィンドウまたはオーバーレイで開くことができます。閉じると、 UI でアドオンが再読み込みされます。
setSuggestionsAction()	ユーザーが入力にテキストを入力する	TextInput	Action を設定する これは、ユーザーがスペースにテキストを入力したときに Apps Script 関数を実行します。 作成します。ハンドラは自動的に イベント オブジェクトを、その関数が呼び出す関数に追加するようにします。 詳しくは、 予測入力の候補 テキスト入力用をご覧ください。

コールバック関数

コールバック関数は、Action の実行時に実行される 使用できます。コールバック関数は Apps Script 関数なので、 他のスクリプト関数でできることのほとんどすべてを 実行できます

警告: Apps Script カードサービス は、コールバック関数の実行時間を最大 30 秒に制限しています。条件 それより長い時間を要する場合、アドオン UI によってアプリケーションの レスポンスで適切に Action。

コールバック関数は特定のレスポンス オブジェクトを返すことがあります。これらの レスポンスの種類は、Google Cloud リソースへの 新しいカードの表示やプレゼンテーションの 予測入力の候補を表示します。コールバック関数が特定の値を返す必要がある場合は、 カードサービスのビルダークラスを使用して、 そのオブジェクトを構築できます。

次の表は、どのような場合にコールバック関数が レスポンスオブジェクトを返します。これらはすべて : アドオンが拡張する特定のホスト アプリケーションに依存しません。

アクションを試行しました	コールバック関数は
カードを移動する	ActionResponse
Notification を表示する	ActionResponse
setOnClickOpenLinkAction() を使用してリンクを開く	ActionResponse
予測入力の候補を表示する	SuggestionResponse
ユニバーサル アクションを使用する	UniversalActionResponse
その他の操作	Nothing

これらのアクションに加えて、各ホスト アプリケーションには独自の そのホストでのみ実行できるアクションを指定します。詳しくは、次をご覧ください。 ガイド:

• カレンダーの操作
• ユーザー行動を促進する
• Gmail の操作
• エディタの操作

で確認できます。

注: レスポンス ビルダー クラスを使用する場合は、build() を呼び出して レスポンス オブジェクトを生成します。そうしないと、エラーが発生します。

注: ユニバーサル アクションは、 プロジェクト マニフェスト内に存在し、Action は不要な 使用できますが、そのコールバック関数は UniversalActionResponse。

アクション イベント オブジェクト

アドオンが Action をトリガーすると、 UI は自動的に JSON イベント オブジェクトを作成し、 Action コールバックに引数を渡すことで、 使用します。このイベント オブジェクトには、ユーザーの現在の IP アドレス、 すべてのインタラクティブ アクティビティの現在の値など、 必要があります。

アクション イベント オブジェクトは、イベント イベントを整理する特定の JSON 構造を持ちます。 情報を提供します。同じ構造が ホームページ トリガー ホームページが作成される場合や コンテキスト トリガー が起動され、アドオン ディスプレイが更新されます。

詳しくは、イベント オブジェクトをご覧ください。 イベント オブジェクト構造の説明です。

注: Gmail のアドオンでは、このイベント オブジェクト構造の簡易版が使用されていました。 使用できます下位互換性を確保するために、元のバージョンと Gmail アドオンのイベント オブジェクトのフィールドが新しいイベントに引き続き含まれる （イベント オブジェクトの構造をご覧ください）。 ただし、同じ情報が 一般的なイベント および Gmail のイベント サブ構造体を作成します。Gmail アドオンを コードを調整する必要があります。 更新後のイベント オブジェクト フィールドを使用します。 イベント オブジェクトのフィールドが削除されます。