本頁面由 Cloud Translation API 翻譯而成。

在資訊卡中新增互動式 UI 元素

本頁說明如何在資訊卡中新增小工具和 UI 元素，讓使用者與 Google Chat 應用程式互動，例如點選按鈕或提交資訊。

Chat 應用程式可使用下列 Chat 介面建構互動式資訊卡：

訊息含有一或多張資訊卡。
首頁：在與 Chat 應用程式的即時訊息中，從「首頁」分頁顯示的資訊卡。
對話方塊：從訊息和首頁在新視窗中開啟的資訊卡。

使用者與資訊卡互動時，Chat 應用程式可使用收到的資料進行處理並做出相應的回應。詳情請參閱「收集及處理 Google Chat 使用者的資訊」。

使用資訊卡建構工具設計及預覽 Chat 應用程式的訊息和使用者介面：

開啟「資訊卡建立工具」

必要條件

已設定為接收及回應互動事件的 Google Chat 應用程式。如要建立互動式 Chat 應用程式，請根據要使用的應用程式架構，完成下列其中一個快速入門導覽：

新增按鈕

「ButtonList」小工具」會顯示一組按鈕。按鈕可以顯示文字、圖示，或同時顯示文字和圖示。每個 Button 都支援使用者點選按鈕時發生的 OnClick 動作。例如：

使用 OpenLink 開啟超連結，為使用者提供額外資訊。
執行 action ，執行自訂函式，例如呼叫 API。

為方便使用，按鈕支援替代文字。

新增執行自訂函式的按鈕

以下是包含 ButtonList 小工具和兩個按鈕的資訊卡。其中一個按鈕會在新的分頁中開啟 Google Chat 開發人員說明文件。另一個按鈕會執行名為 goToView() 的自訂函式，並傳遞 viewType="BIRD EYE VIEW" 參數。

新增 Material Design 樣式的按鈕

以下顯示一組按鈕，採用不同的 Material Design 按鈕樣式。

如要套用 Material Design 樣式，請勿加入「顏色」屬性。

新增自訂顏色按鈕和停用按鈕

您可以設定 "disabled": "true"，禁止使用者點選按鈕。

下方顯示的資訊卡包含 ButtonList 小工具和兩個按鈕。其中一個按鈕使用 Color 欄位自訂按鈕的背景顏色。另一個按鈕會透過 Disabled 欄位停用，防止使用者點選按鈕並執行函式。

新增含圖示的按鈕

下圖顯示包含 ButtonList 小工具的資訊卡，以及兩個圖示 Button 小工具。其中一個按鈕使用 knownIcon 欄位顯示 Google Chat 的內建電子郵件圖示。另一個按鈕則使用 iconUrl 欄位顯示自訂圖示小工具。

新增含有圖示和文字的按鈕

下圖顯示的資訊卡包含 ButtonList 小工具，提示使用者傳送電子郵件。第一個按鈕會顯示電子郵件圖示，第二個按鈕則會顯示文字。使用者可以點選圖示或文字按鈕，執行 sendEmail 函式。

自訂可收合專區的按鈕

自訂控制按鈕，用於收合及展開資訊卡中的區塊。從一系列圖示或圖片中選擇，以視覺化方式呈現專區內容，方便使用者瞭解資訊並與之互動。

新增溢位選單

Overflow menu 可用於 Chat 資訊卡，提供其他選項和動作。您可以在不讓資訊卡介面顯得雜亂的情況下，加入更多選項，確保設計整潔有序。

新增方塊清單

ChipList 小工具提供多種用途，且視覺上極具吸引力，可顯示資訊。使用晶片清單代表標記、類別或其他相關資料，讓使用者更容易瀏覽及與內容互動。

收集使用者資訊

本節說明如何新增可收集資訊的小工具，例如文字或選項。

如要瞭解如何處理使用者輸入的內容，請參閱「收集及處理 Google Chat 使用者的資訊」。

收集文字

TextInput 小工具提供可供使用者輸入文字的欄位。這個小工具支援建議，可協助使用者輸入統一資料，以及變更時執行的動作，例如使用者在文字輸入欄位中新增或刪除文字時執行的動作。Actions

如需收集使用者的抽象或不明資料，請使用這個 TextInput 小工具。如要向使用者收集定義的資料，請改用 SelectionInput 小工具。

以下是包含 TextInput 小工具的資訊卡：

收集日期或時間

使用者可以透過 DateTimePicker 小工具輸入日期、時間，或同時輸入日期和時間。使用者也可以使用挑選器選取日期和時間。如果使用者輸入無效的日期或時間，挑選器會顯示錯誤訊息，提示使用者正確輸入資訊。

以下顯示的卡片包含三種不同類型的DateTimePicker小工具：

允許使用者選取項目

SelectionInput 小工具提供一組可選取的項目，例如核取方塊、圓形按鈕、切換鈕或下拉式選單。您可以使用這個小工具，向使用者收集定義和標準化的資料。如要收集使用者未定義的資料，請改用 TextInput 小工具。

SelectionInput 小工具支援建議 (可協助使用者輸入一致的資料) 和變更動作 (當選取輸入欄位發生變更時執行的 Actions，例如使用者選取或取消選取項目)。

聊天應用程式可以接收及處理所選項目值。如要瞭解如何處理表單輸入內容，請參閱「處理使用者輸入的資訊」。

本節提供使用 SelectionInput 小工具的資訊卡範例。這些範例使用不同類型的區段輸入內容：

核取方塊
圓形按鈕
切換鈕
下拉式選單
多選選單

新增核取方塊

下圖顯示一張卡片，要求使用者指定聯絡人是專業、個人或兩者皆是，並使用含有核取方塊的 SelectionInput 小工具：

新增單選按鈕

以下顯示的資訊卡會要求使用者指定聯絡人是專業或個人聯絡人，並使用含有單選按鈕的 SelectionInput 小工具：

新增切換鈕

以下顯示的資訊卡會要求使用者指定聯絡人是專業、個人或兩者皆是，並使用含有切換鈕的 SelectionInput 小工具：

以下顯示的資訊卡會要求使用者指定聯絡人是專業或個人聯絡人，並使用下拉式選單的 SelectionInput 小工具：

以下顯示的資訊卡會要求使用者從多選選單中選取聯絡人：

您可以從 Google Workspace 的下列資料來源，填入多選式選單的項目：

Google Workspace 使用者：您只能填入同一 Google Workspace 機構內的使用者。
Chat 聊天室：在多選選單中輸入項目的使用者，只能查看及選取所屬 Google Workspace 機構中的聊天室。

如要使用 Google Workspace 資料來源，請指定 platformDataSource 欄位。與其他選取輸入類型不同，您會省略 SelectionItem 物件，因為這些選取項目是從 Google Workspace 動態取得。

下列程式碼顯示 Google Workspace 使用者的多選式選單。如要填入使用者，選取輸入內容會將 commonDataSource 設為 USER：

JSON

{
  "selectionInput": {
    "name": "contacts",
    "type": "MULTI_SELECT",
    "label": "Selected contacts",
    "multiSelectMaxSelectedItems": 5,
    "multiSelectMinQueryLength": 1,
    "platformDataSource": {
      "commonDataSource": "USER"
    }
  }
}

下列程式碼顯示 Chat 空間的多選選單。如要填入空格，選取輸入內容會指定 hostAppDataSource 欄位。多重選取選單也會將 defaultToCurrentSpace 設為 true，讓目前空間成為選單中的預設選項：

JSON

{
  "selectionInput": {
    "name": "spaces",
    "type": "MULTI_SELECT",
    "label": "Selected contacts",
    "multiSelectMaxSelectedItems": 3,
    "multiSelectMinQueryLength": 1,
    "platformDataSource": {
      "hostAppDataSource": {
        "chatDataSource": {
          "spaceDataSource": {
            "defaultToCurrentSpace": true
          }
        }
      }
    }
  }
}

多選單也可以從第三方或外部資料來源填入項目。舉例來說，您可以使用多選式選單，協助使用者從顧客關係管理 (CRM) 系統的銷售待開發客戶清單中選取項目。

如要使用外部資料來源，請使用 externalDataSource 欄位指定函式，從資料來源傳回項目。

如要減少對外部資料來源的要求，可以在使用者輸入選單內容前，先在多重選取選單中加入建議項目。舉例來說，您可以為使用者填入最近搜尋的聯絡人。如要從外部資料來源填入建議項目，請指定 SelectionItem 物件。

下列程式碼會顯示使用者的外部聯絡人集項目多選選單。選單預設會顯示一個聯絡人，並執行 getContacts 函式，從外部資料來源擷取及填入項目：

Node.js

node/selection-input/index.js

前往 GitHub 查看

selectionInput: {
  name: "contacts",
  type: "MULTI_SELECT",
  label: "Selected contacts",
  multiSelectMaxSelectedItems: 3,
  multiSelectMinQueryLength: 1,
  externalDataSource: { function: "getContacts" },
  // Suggested items loaded by default.
  // The list is static here but it could be dynamic.
  items: [getContact("3")]
}

Python

python/selection-input/main.py

前往 GitHub 查看

'selectionInput': {
  'name': "contacts",
  'type': "MULTI_SELECT",
  'label': "Selected contacts",
  'multiSelectMaxSelectedItems': 3,
  'multiSelectMinQueryLength': 1,
  'externalDataSource': { 'function': "getContacts" },
  # Suggested items loaded by default.
  # The list is static here but it could be dynamic.
  'items': [get_contact("3")]
}

Java

java/selection-input/src/main/java/com/google/chat/selectionInput/App.java

前往 GitHub 查看

.setSelectionInput(new GoogleAppsCardV1SelectionInput()
  .setName("contacts")
  .setType("MULTI_SELECT")
  .setLabel("Selected contacts")
  .setMultiSelectMaxSelectedItems(3)
  .setMultiSelectMinQueryLength(1)
  .setExternalDataSource(new GoogleAppsCardV1Action().setFunction("getContacts"))
  .setItems(List.of(getContact("3")))))))))));

Apps Script

apps-script/selection-input/selection-input.gs

前往 GitHub 查看

selectionInput: {
  name: "contacts",
  type: "MULTI_SELECT",
  label: "Selected contacts",
  multiSelectMaxSelectedItems: 3,
  multiSelectMinQueryLength: 1,
  externalDataSource: { function: "getContacts" },
  // Suggested items loaded by default.
  // The list is static here but it could be dynamic.
  items: [getContact("3")]
}

如果是外部資料來源，使用者在多選選單中開始輸入項目時，系統也會自動完成。舉例來說，如果使用者開始輸入 Atl，系統會顯示美國境內的城市選單，您的 Chat 應用程式可以在使用者完成輸入前自動建議 Atlanta。最多可自動完成 100 個項目。

如要自動完成項目，請建立函式，在使用者於多選單中輸入內容時查詢外部資料來源，並傳回項目。這個函式必須執行下列操作：

傳遞代表使用者與選單互動的事件物件。
確認互動事件的 invokedFunction 值與 externalDataSource 欄位中的函式相符。
如果函式相符，則從外部資料來源傳回建議項目。如要根據使用者輸入的內容建議項目，請取得 autocomplete_widget_query 鍵的值。這個值代表使用者在選單中輸入的內容。

以下程式碼會自動完成外部資料資源中的項目。以上述範例為例，當函式 getContacts 觸發時，即時通訊應用程式會根據下列情況建議項目：

Node.js

node/selection-input/index.js

前往 GitHub 查看

/**
 * Responds to a WIDGET_UPDATE event in Google Chat.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app.
 */
function onWidgetUpdate(event) {
  if (event.common["invokedFunction"] === "getContacts") {
    const query = event.common.parameters["autocomplete_widget_query"];
    return { actionResponse: {
      type: "UPDATE_WIDGET",
      updatedWidget: { suggestions: { items: [
        // The list is static here but it could be dynamic.
        getContact("1"), getContact("2"), getContact("3"), getContact("4"), getContact("5")
      // Only return items based on the query from the user
      ].filter(e => !query || e.text.includes(query))}}
    }};
  }
}

/**
 * Generate a suggested contact given an ID.
 *
 * @param {String} id The ID of the contact to return.
 * @return {Object} The contact formatted as a suggested item for selectors.
 */
function getContact(id) {
  return {
    value: id,
    startIconUri: "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
    text: "Contact " + id
  };
}

Python

python/selection-input/main.py

前往 GitHub 查看

def on_widget_update(event: dict) -> dict:
  """Responds to a WIDGET_UPDATE event in Google Chat."""
  if "getContacts" == event.get("common").get("invokedFunction"):
    query = event.get("common").get("parameters").get("autocomplete_widget_query")
    return { 'actionResponse': {
      'type': "UPDATE_WIDGET",
      'updatedWidget': { 'suggestions': { 'items': list(filter(lambda e: query is None or query in e["text"], [
        # The list is static here but it could be dynamic.
        get_contact("1"), get_contact("2"), get_contact("3"), get_contact("4"), get_contact("5")
      # Only return items based on the query from the user
      ]))}}
    }}


def get_contact(id: str) -> dict:
  """Generate a suggested contact given an ID."""
  return {
    'value': id,
    'startIconUri': "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
    'text': "Contact " + id
  }

Java

java/selection-input/src/main/java/com/google/chat/selectionInput/App.java

前往 GitHub 查看

// Responds to a WIDGET_UPDATE event in Google Chat.
Message onWidgetUpdate(JsonNode event) {
  if ("getContacts".equals(event.at("/invokedFunction").asText())) {
    String query = event.at("/common/parameters/autocomplete_widget_query").asText();
    return new Message().setActionResponse(new ActionResponse()
      .setType("UPDATE_WIDGET")
      .setUpdatedWidget(new UpdatedWidget()
        .setSuggestions(new SelectionItems().setItems(List.of(
          // The list is static here but it could be dynamic.
          getContact("1"), getContact("2"), getContact("3"), getContact("4"), getContact("5")
        // Only return items based on the query from the user
        ).stream().filter(e -> query == null || e.getText().indexOf(query) > -1).toList()))));
  }
  return null;
}

// Generate a suggested contact given an ID.
GoogleAppsCardV1SelectionItem getContact(String id) {
  return new GoogleAppsCardV1SelectionItem()
    .setValue(id)
    .setStartIconUri("https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png")
    .setText("Contact " + id);
}

Apps Script

apps-script/selection-input/selection-input.gs

前往 GitHub 查看

/**
 * Responds to a WIDGET_UPDATE event in Google Chat.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app.
 */
function onWidgetUpdate(event) {
  if (event.common["invokedFunction"] === "getContacts") {
    const query = event.common.parameters["autocomplete_widget_query"];
    return { actionResponse: {
      type: "UPDATE_WIDGET",
      updatedWidget: { suggestions: { items: [
        // The list is static here but it could be dynamic.
        getContact("1"), getContact("2"), getContact("3"), getContact("4"), getContact("5")
      // Only return items based on the query from the user
      ].filter(e => !query || e.text.includes(query))}}
    }};
  }
}

/**
 * Generate a suggested contact given an ID.
 *
 * @param {String} id The ID of the contact to return.
 * @return {Object} The contact formatted as a suggested item for selectors.
 */
function getContact(id) {
  return {
    value: id,
    startIconUri: "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
    text: "Contact " + id
  };
}

驗證輸入至資訊卡的資料

本頁說明如何驗證輸入至資訊卡 action 和小工具的資料。舉例來說，您可以驗證文字輸入欄位是否含有使用者輸入的文字，或是含有特定數量的字元。

為動作設定必要的小工具

在資訊卡的 action 中，將動作所需的小工具名稱新增至 requiredWidgets 清單。

如果叫用這項動作時，這裡列出的任何小工具都沒有值，表單動作提交就會取消。

如果為動作設定 "all_widgets_are_required": "true"，則動作必須使用資訊卡中的所有小工具。

在多重選取畫面中設定 `all_widgets_are_required` 動作

JSON

{
  "sections": [
    {
      "header": "Select contacts",
      "widgets": [
        {
          "selectionInput": {
            "type": "MULTI_SELECT",
            "label": "Selected contacts",
            "name": "contacts",
            "multiSelectMaxSelectedItems": 3,
            "multiSelectMinQueryLength": 1,
            "onChangeAction": {
              "all_widgets_are_required": true
            },
            "items": [
              {
                "value": "contact-1",
                "startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
                "text": "Contact 1",
                "bottomText": "Contact one description",
                "selected": false
              },
              {
                "value": "contact-2",
                "startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
                "text": "Contact 2",
                "bottomText": "Contact two description",
                "selected": false
              },
              {
                "value": "contact-3",
                "startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
                "text": "Contact 3",
                "bottomText": "Contact three description",
                "selected": false
              },
              {
                "value": "contact-4",
                "startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
                "text": "Contact 4",
                "bottomText": "Contact four description",
                "selected": false
              },
              {
                "value": "contact-5",
                "startIconUri": "https://www.gstatic.com/images/branding/product/2x/contacts_48dp.png",
                "text": "Contact 5",
                "bottomText": "Contact five description",
                "selected": false
              }
            ]
          }
        }
      ]
    }
  ]
}

在 dateTimePicker 中設定 `all_widgets_are_required` 動作

JSON

{
  "sections": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "A datetime picker widget with both date and time:"
          }
        },
        {
          "divider": {}
        },
        {
          "dateTimePicker": {
            "name": "date_time_picker_date_and_time",
            "label": "meeting",
            "type": "DATE_AND_TIME"
          }
        },
        {
          "textParagraph": {
            "text": "A datetime picker widget with just date:"
          }
        },
        {
          "divider": {}
        },
        {
          "dateTimePicker": {
            "name": "date_time_picker_date_only",
            "label": "Choose a date",
            "type": "DATE_ONLY",
            "onChangeAction":{
              "all_widgets_are_required": true
            }
          }
        },
        {
          "textParagraph": {
            "text": "A datetime picker widget with just time:"
          }
        },
        {
          "divider": {}
        },
        {
          "dateTimePicker": {
            "name": "date_time_picker_time_only",
            "label": "Select a time",
            "type": "TIME_ONLY"
          }
        }
      ]
    }
  ]
}

在下拉式選單中設定 `all_widgets_are_required` 動作

JSON

{
  "sections": [
    {
      "header": "Section Header",
      "collapsible": true,
      "uncollapsibleWidgetsCount": 1,
      "widgets": [
        {
          "selectionInput": {
            "name": "location",
            "label": "Select Color",
            "type": "DROPDOWN",
            "onChangeAction": {
              "all_widgets_are_required": true
            },
            "items": [
              {
                "text": "Red",
                "value": "red",
                "selected": false
              },
              {
                "text": "Green",
                "value": "green",
                "selected": false
              },
              {
                "text": "White",
                "value": "white",
                "selected": false
              },
              {
                "text": "Blue",
                "value": "blue",
                "selected": false
              },
              {
                "text": "Black",
                "value": "black",
                "selected": false
              }
            ]
          }
        }
      ]
    }
  ]
}

設定文字輸入小工具的驗證

在 textInput 小工具的驗證欄位中，可以指定這個文字輸入小工具的字元限制和輸入類型。

設定文字輸入小工具的字元限制

JSON

{
  "sections": [
    {
      "header": "Tell us about yourself",
      "collapsible": true,
      "uncollapsibleWidgetsCount": 2,
      "widgets": [
        {
          "textInput": {
            "name": "favoriteColor",
            "label": "Favorite color",
            "type": "SINGLE_LINE",
            "validation": {"character_limit":15},
            "onChangeAction":{
              "all_widgets_are_required": true
            }
          }
        }
      ]
    }
  ]
}

為文字輸入小工具設定輸入類型

JSON

{
  "sections": [
    {
      "header": "Validate text inputs by input types",
      "collapsible": true,
      "uncollapsibleWidgetsCount": 2,
      "widgets": [
        {
          "textInput": {
            "name": "mailing_address",
            "label": "Please enter a valid email address",
            "type": "SINGLE_LINE",
            "validation": {
              "input_type": "EMAIL"
            },
            "onChangeAction": {
              "all_widgets_are_required": true
            }
          }
        },
        {
          "textInput": {
            "name": "validate_integer",
            "label": "Please enter a number",
              "type": "SINGLE_LINE",
            "validation": {
              "input_type": "INTEGER"
            }
          }
        },
        {
          "textInput": {
            "name": "validate_float",
            "label": "Please enter a number with a decimal",
            "type": "SINGLE_LINE",
            "validation": {
              "input_type": "FLOAT"
            }
          }
        }
      ]
    }
  ]
}

疑難排解

如果 Google Chat 應用程式或資訊卡傳回錯誤，Chat 介面會顯示「發生錯誤」訊息。或「無法處理您的要求」。有時 Chat UI 不會顯示任何錯誤訊息，但 Chat 應用程式或資訊卡會產生非預期結果，例如資訊卡訊息可能不會顯示。

即使 Chat 使用者介面未顯示錯誤訊息，只要開啟 Chat 應用程式的錯誤記錄功能，系統就會提供說明性錯誤訊息和記錄資料，協助您修正錯誤。如需查看、偵錯及修正錯誤的相關協助，請參閱「排解及修正 Google Chat 錯誤」。

在資訊卡中新增互動式 UI 元素 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

必要條件

新增按鈕

新增執行自訂函式的按鈕

新增 Material Design 樣式的按鈕

新增自訂顏色按鈕和停用按鈕

新增含圖示的按鈕

新增含有圖示和文字的按鈕

自訂可收合專區的按鈕

新增溢位選單

新增方塊清單

收集使用者資訊

收集文字

收集日期或時間

允許使用者選取項目

新增核取方塊

新增單選按鈕

新增切換鈕

新增下拉式選單

新增多重選取選單

JSON

JSON

Node.js

Python

Java

Apps Script

Node.js

Python

Java

Apps Script

驗證輸入至資訊卡的資料

為動作設定必要的小工具

在多重選取畫面中設定 all_widgets_are_required 動作

JSON

在 dateTimePicker 中設定 all_widgets_are_required 動作

JSON

在下拉式選單中設定 all_widgets_are_required 動作

JSON

設定文字輸入小工具的驗證

設定文字輸入小工具的字元限制

JSON

為文字輸入小工具設定輸入類型

JSON

疑難排解

相關主題

在資訊卡中新增互動式 UI 元素

在多重選取畫面中設定 `all_widgets_are_required` 動作

在 dateTimePicker 中設定 `all_widgets_are_required` 動作

在下拉式選單中設定 `all_widgets_are_required` 動作