Action

フォームが送信されたときの動作を記述するアクション。たとえば、Apps Script スクリプトを呼び出してフォームを処理できます。アクションがトリガーされると、フォームの値がサーバーに送信されます。

Google Chat アプリと Google Workspace アドオンで使用できます。

JSON 表現 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
フィールド
function

string

コンテナ要素がクリックされるか、その他の方法で有効化されたときに呼び出すカスタム関数。

使用例については、フォームデータを読み取るをご覧ください。
parameters[]

object (ActionParameter)

アクション パラメータのリスト。
loadIndicator

enum (LoadIndicator)

アクションの呼び出し中にアクションが表示する読み込みインジケーターを指定します。
persistValues

boolean

アクション後にフォーム値が保持されるかどうかを示します。デフォルト値は false です。

true の場合、アクションがトリガーされた後もフォームの値は保持されます。アクションの処理中にユーザーが変更を行えるようにするには、LoadIndicator を NONE に設定します。Chat アプリのカード メッセージの場合、アクションの ResponseType を UPDATE_MESSAGE に設定し、アクションを含むカードと同じ cardId を使用する必要があります。

false の場合、アクションがトリガーされるとフォームの値がクリアされます。アクションの処理中にユーザーが変更できないようにするには、LoadIndicator を SPINNER に設定します。
interaction

enum (Interaction)

省略可。ダイアログを開く場合に必須。

ユーザーがカード メッセージのボタンをクリックするなど、ユーザーとのインタラクションに応じて行う処理。

指定しない場合、アプリは通常どおり action を実行（リンクを開く、関数を実行するなど）して応答します。

interaction を指定することで、アプリは特別なインタラクティブな方法で応答できます。たとえば、interaction を OPEN_DIALOG に設定すると、アプリはダイアログを開くことができます。指定すると、読み込みインジケーターは表示されません。アドオンに指定すると、カード全体が削除され、クライアントには何も表示されません。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。
requiredWidgets[]

string

省略可。このリストに、このアクションが有効な送信に必要なウィジェットの名前を入力します。

このアクションが呼び出されたときに、ここにリストされているウィジェットに値がない場合、フォームの送信は中止されます。

Google Chat アプリと Google Workspace アドオンで使用できます。
allWidgetsAreRequired

boolean

省略可。これが true の場合、すべてのウィジェットがこのアクションで必須と見なされます。

Google Chat アプリと Google Workspace アドオンで使用できます。

ActionParameter

アクション メソッドが呼び出されたときに指定する文字列パラメータのリスト。たとえば、[今すぐスヌーズ]、[1 日スヌーズ]、[来週スヌーズ] の 3 つのスヌーズ ボタンがあるとします。action method = snooze() を使用して、文字列パラメータのリストでスヌーズタイプとスヌーズ時間を渡すことができます。

詳しくは、CommonEventObject をご覧ください。

Google Chat アプリと Google Workspace アドオンで使用できます。

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string

アクション スクリプトのパラメータの名前。
value

string

パラメータの値。

LoadIndicator

アクションの呼び出し中にアクションが表示する読み込みインジケーターを指定します。

Google Chat アプリと Google Workspace アドオンで使用できます。

列挙型
SPINNER コンテンツの読み込み中であることを示すスピナーを表示する。
NONE 何も表示されない。

インタラクション

省略可。ダイアログを開く場合に必須。

ユーザーがカード メッセージのボタンをクリックするなど、ユーザーとのインタラクションに応じて行う処理。

指定しない場合、アプリは通常どおり action を実行（リンクを開く、関数を実行するなど）して応答します。

interaction を指定することで、アプリは特別なインタラクティブな方法で応答できます。たとえば、interaction を OPEN_DIALOG に設定すると、アプリはダイアログを開くことができます。

指定すると、読み込みインジケーターは表示されません。アドオンに指定すると、カード全体が削除され、クライアントには何も表示されません。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

列挙型
INTERACTION_UNSPECIFIED デフォルト値。action は通常どおり実行されます。
OPEN_DIALOG

ダイアログを開きます。ダイアログは、Chat アプリがユーザーとのやり取りに使用する、ウィンドウ表示のカードベースのインターフェースです。

カード メッセージのボタンクリックに応答する Chat アプリでのみサポートされています。アドオンに指定すると、カード全体が削除され、クライアントには何も表示されません。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。