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

叫用動作方法時要提供的字串參數清單。舉例來說，你可以提供三個延後按鈕：立即延後、延後一天或延後一週。您可以使用 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 外掛程式。