建立互動式資訊卡

除了顯示資料,大部分的外掛程式都會要求使用者輸入資訊。建構卡片式外掛程式時,您可以使用互動式 小工具 (例如按鈕、工具列選單項目或核取方塊),要求使用者提供外掛程式所需的資料,或提供其他互動控制項。

為小工具新增動作

在大多數情況下,您可以將小工具連結至特定動作,並在回呼函式中實作必要行為,讓小工具具備互動功能。詳情請參閱外掛動作

在大多數情況下,您可以按照以下一般程序設定小工具,讓小工具在選取或更新時執行特定動作:

  1. 建立 Action 物件,指定應執行的回呼函式,以及任何必要參數。
  2. 呼叫適當的 小工具處理常式函式,將小工具連結至 Action
  3. 實作回呼函式,以執行必要的行為。

範例

以下範例會設定按鈕,在使用者點選後顯示通知。點選會觸發 notifyUser() 回呼函式,並使用指定通知文字的引數。傳回已建構的 ActionResponse 會顯示通知。

  /**
   * Build a simple card with a button that sends a notification.
   * @return {Card}
   */
  function buildSimpleCard() {
    var buttonAction = CardService.newAction()
        .setFunctionName('notifyUser')
        .setParameters({'notifyText': 'Button clicked!'});
    var button = CardService.newTextButton()
        .setText('Notify')
        .setOnClickAction(buttonAction);

    // ...continue creating widgets, then create a Card object
    // to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Constructs a
   * notification action response and returns it.
   * @param {Object} e the action event object
   * @return {ActionResponse}
   */
  function notifyUser(e) {
    var parameters = e.parameters;
    var notificationText = parameters['notifyText'];
    return CardService.newActionResponseBuilder()
        .setNotification(CardService.newNotification()
            .setText(notificationText))
        .build();      // Don't forget to build the response!
  }

設計有效的互動

設計互動資訊卡時,請注意下列事項:

  • 互動式小工具通常需要至少一個處理常式來定義行為。

  • 如果您有網址,且只想在分頁中開啟網址,請使用 setOpenLink() 小工具處理程序函式。這樣就不必定義 Action 物件和回呼函式。如果您需要先建立網址,或在開啟網址前採取其他額外步驟,請定義 Action,並改用 setOnClickOpenLinkAction()

  • 使用 setOpenLink()setOnClickOpenLinkAction() 小工具處理常式函式時,您需要提供 OpenLink 物件,以便定義要開啟的網址。您也可以使用這個物件,透過 OpenAsOnClose 列舉指定開啟和關閉行為。

  • 多個小工具可以使用相同的 Action 物件。不過,如果您想為回呼函式提供不同的參數,就必須定義不同的 Action 物件。

  • 請簡化回呼函式。為了讓外掛程式保持回應能力,Card 服務會將回呼函式的執行時間限制在 30 秒以內。如果執行作業的時間超過這個時間,外掛程式 UI 可能無法在回應 Action 時,正確更新卡片顯示畫面。

  • 如果使用者與外掛程式 UI 互動,導致第三方後端的資料狀態有所變更,建議您將外掛程式中的「state changed」位元設為 true,以便清除任何現有的用戶端快取。詳情請參閱 ActionResponseBuilder.setStateChanged() 方法說明。