Class Action

アクション

UI 要素内でインタラクティビティを可能にするアクション。アクションはファイル上で直接行われず、 Apps Script コールバック関数を呼び出す オプションのパラメータがあります。

Google Workspace アドオンと Google Chat アプリでご利用いただけます。 

var image = CardService.newImage()
    .setOnClickAction(CardService.newAction()
        .setFunctionName("handleImageClick")
        .setParameters({imageSrc: 'carImage'}));

メソッド

メソッド戻り値の型概要
addRequiredWidget(requiredWidget)Actionこのアクションが有効な送信に必要とするウィジェットの名前を追加します。
setAllWidgetsAreRequired(allWidgetsAreRequired)Actionこのアクションがすべてのウィジェットからの入力を必要とするかどうかを示します。
setFunctionName(functionName)Action呼び出されるコールバック関数の名前を設定します。
setInteraction(interaction)Actionユーザーとのやり取りを設定します。ダイアログを開く場合にのみ必要です。
setLoadIndicator(loadIndicator)Actionアクションの進行中に表示される読み込みインジケーターを設定します。
setParameters(parameters)Actionカスタム パラメータをコールバック関数に渡すことができます。
setPersistValues(persistValues)Actionフォームの値がクライアントの値とサーバーの値のどちらで決定されるのかを示します アクションのレスポンスの後に、フォームの Card が更新されます。

詳細なドキュメント

addRequiredWidget(requiredWidget)

このアクションが有効な送信に必要とするウィジェットの名前を追加します。もしウィジェットが このアクションが呼び出されたときにこのリストに値がない場合、フォームの送信は中止されます。

Google Chat アプリでのみ使用できます。Google Workspace アドオンではご利用いただけません。 

var textInput = CardService.newTextInput()
    .setFieldName("text_input_1")
    .setTitle("Text input title")

// Creates a footer button that requires an input from the above TextInput Widget.
var action = CardService.newAction()
    .setFunctionName("notificationCallback")
    .addRequiredWidget("text_input_1");
var fixedFooter =
      CardService
          .newFixedFooter()
          .setPrimaryButton(
              CardService
                  .newTextButton()
                  .setText("help")
                  .setOnClickAction(action));

パラメータ

名前型説明
requiredWidgetStringこのアクションに必要なウィジェットの名前。

戻る

Action - チェーン用のオブジェクト。

setAllWidgetsAreRequired(allWidgetsAreRequired)

このアクションがすべてのウィジェットからの入力を必要とするかどうかを示します。

Google Chat アプリでのみ使用できます。Google Workspace アドオンではご利用いただけません。 

// Creates a button with an action that requires inputs from all widgets.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setAllWidgetsAreRequired(true));

パラメータ

名前型説明
allWidgetsAreRequiredBooleanアクションがすべてのウィジェットからの入力を必要とするかどうか。デフォルトは false。

戻る

Action - チェーン用のオブジェクト。

setFunctionName(functionName)

呼び出されるコールバック関数の名前を設定します。必須。

パラメータ

名前型説明
functionNameString関数の名前。含まれているライブラリや Library.libFunction1 など。

戻る

Action - チェーン用のオブジェクト。

setInteraction(interaction)

ユーザーとのやり取りを設定します。ダイアログを開く場合にのみ必要です。指定しない場合、アプリは 通常どおりリンクを開く、関数を実行するなど、Action を実行して応答する。

Google Chat アプリでのみ使用できます。Google Workspace アドオンではご利用いただけません。 

const action = CardService.newAction()
    .setFunctionName('handleDialog')
    .setInteraction(CardService.Interaction.OPEN_DIALOG);

パラメータ

名前型説明
interactionInteraction指定するインタラクション。

戻る

Action - チェーン用のオブジェクト。

setLoadIndicator(loadIndicator)

アクションの進行中に表示される読み込みインジケーターを設定します。

パラメータ

名前型説明
loadIndicatorLoadIndicator表示するインジケーター。

戻る

Action - チェーン用のオブジェクト。

setParameters(parameters)

カスタム パラメータをコールバック関数に渡すことができます。省略可。

パラメータ

名前型説明
parametersObjectキーと値はどちらも文字列である必要があります。

戻る

Action - チェーン用のオブジェクト。

setPersistValues(persistValues)

フォームの値がクライアントの値とサーバーの値のどちらで決定されるのかを示します アクションのレスポンスの後に、フォームの Card が更新されます。true に設定すると、 クライアントの値はサーバー レスポンスの後も保持されます。false に設定すると、サーバーの フォームの値は上書きされます。デフォルトは false です。

クライアントの値を保持することで、フォームが予期せず変更されるのを防ぐことができます。 ユーザーが編集を行った後にたとえば、変更後にユーザーが TextInput を編集した場合、 サーバーが応答するまでの間です。値が保持されている場合は、 サーバーの応答が Card を更新した後もユーザーが残っているそれ以外の場合はフォームの ユーザーが最初にフォームに送信した値に戻ります。

クライアント値を保持すると、スクリプトでフォーム フィールドをクリアしたり、 フォームの値をオーバーライドするため、そのタイプの機能では永続性を有効にしないでください。なし イベントには LoadIndicator.SPINNER を使用することをおすすめします。 UI がロックされ、サーバーが応答する前にユーザーが編集できなくなるためです。または LoadIndicator.NONE を使用して、フォーム内のすべての要素に onChange があることを確認できます。 できます。 

// Creates a button with an action that persists the client's values as the on-click action.
const button = CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(
        CardService.newAction()
            .setPersistValues(true)
            .setFunctionName('functionName'));

パラメータ

名前型説明
persistValuesBoolean値を保持するかどうか。デフォルトは false です。

戻る

Action - チェーン用のオブジェクト。

サポート終了のメソッド