Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

資訊卡的標頭。標題通常包含開頭圖片和標題。標題一律會顯示在資訊卡頂端。

object (Section)

包含一組小工具。每個部分都有自己專屬的選用標頭。以線條分隔線區分各個區塊。如需 Google Chat 應用程式範例，請參閱 定義資訊卡的區段。

enum (DividerStyle)

區段之間的分隔線樣式。

object (CardAction)

資訊卡的動作。動作會新增至資訊卡的工具列選單。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

舉例來說，下列 JSON 會使用 Settings 和 Send Feedback 選項建構資訊卡操作選單：

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

卡片名稱。在卡片瀏覽中當做卡片 ID。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

object (CardFixedFooter)

固定在資訊卡底部的頁尾。

如果在設定 fixedFooter 時未指定 primaryButton 或 secondaryButton，就會發生錯誤。如果是 Chat 擴充應用程式，您可以在以下應用程式中使用固定頁尾： 對話方塊，但不含 資訊卡訊息。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

enum (DisplayStyle)

在 Google Workspace 外掛程式中，設定 peekCardHeader。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

object (CardHeader)

顯示內容比對內容時，跳轉資訊卡標頭做為預留位置，方便使用者在首頁資訊卡和內容相關資訊卡之間瀏覽。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

必要欄位。資訊卡標題的標題。標題的高度固定：如果同時指定標題和副標題，則每個標題都會佔一行。如果僅指定標題，就會佔據兩行。

string

資訊卡標題的副標題。如果有指定，會顯示在 title。

enum (ImageType)

用來裁剪圖片的形狀。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

string

資訊卡標頭中的圖片 HTTPS 網址。

string

這張圖片的替代文字，用於無障礙功能。

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

string

顯示在區段頂端的文字。支援簡易 HTML 格式的文字。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。

object (Widget)

這個區段中的所有小工具。至少必須包含一個小工具。

boolean

指出這個區段是否可收合。

可摺疊的版面可隱藏部分或所有小工具，但使用者只要按一下「顯示更多」，即可展開該版面，查看隱藏的小工具。使用者可以按一下 顯示較少。

如要判斷隱藏哪些小工具，請指定 uncollapsibleWidgetsCount。

integer

即使在摺疊區段時，仍會顯示的不可摺疊小工具數量。

舉例來說，假設區塊包含五個小工具，且 uncollapsibleWidgetsCount 設為 2，系統一律會顯示前兩個小工具，並預設收合後三個小工具。只有在 collapsible 為 true 時，系統才會考慮 uncollapsibleWidgetsCount。

object (CollapseControl)

選用設定。定義區塊的展開和收合按鈕。只有在區段可收合時，系統才會顯示這個按鈕。如果未設定這個欄位，系統會使用預設按鈕。 這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

指定小工具要對齊資料欄的左側、右側或中央。

object (TextParagraph)

顯示文字段落。支援簡易 HTML 格式的文字。如要進一步瞭解如何設定文字格式，請參閱「在 Google Chat 應用程式中設定文字格式」和「在 Google Workspace 外掛程式中設定文字格式」。

舉例來說，下列 JSON 會建立粗體文字：

"textParagraph": {
  "text": "  <b>bold text</b>"
}

object (Image)

顯示圖片。

舉例來說，下列 JSON 會建立含有替代文字的圖片：

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

object (DecoratedText)

顯示經過裝飾的文字項目。

舉例來說，下列 JSON 會建立顯示電子郵件地址的修飾文字小工具：

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

object (ButtonList)

按鈕清單。

舉例來說，下列 JSON 會建立兩個按鈕。第一個是藍色文字按鈕，第二個是可開啟連結的圖片按鈕：

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

object (TextInput)

顯示使用者可輸入內容的文字方塊。

舉例來說，下列 JSON 會建立電子郵件地址的文字輸入內容：

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

再舉一個例子，下列 JSON 會使用靜態建議，建立程式設計語言的文字輸入內容：

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

object (SelectionInput)

顯示選取控制項，讓使用者選取項目。選取控制項可以是核取方塊、圓形按鈕、切換按鈕或下拉式選單。

舉例來說，下列 JSON 會建立下拉式選單，讓使用者選擇尺寸：

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

object (DateTimePicker)

顯示可讓使用者輸入日期、時間或日期和時間的小工具。

舉例來說，下列 JSON 會建立日期/時間挑選器，用於安排預約：

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

object (Divider)

顯示小工具之間的水平分隔線。

例如，下列 JSON 會建立分隔線：

"divider": {
}

object (Grid)

顯示包含一組項目的格狀畫面。

格線支援任意數量的欄和項目。列數取決於項目數上限除以欄數。如果格狀檢視包含 10 個項目，2 欄，則有 5 列。如果格狀檢視包含 11 個項目，2 欄，則有 6 列。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

舉例來說，下列 JSON 會建立含有單一項目的 2 欄格線：

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

object (Columns)

最多顯示 2 欄。

如要加入超過 2 個資料欄，或使用資料列，請使用 Grid

例如，以下 JSON 會建立 2 個資料欄，每個資料欄都包含文字段落：

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

object (ChipList)

方塊清單。

舉例來說，下列 JSON 會建立兩個方塊。第一個是文字方塊，第二個是開啟連結的圖示方塊：

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "text": string,
  "maxLines": integer
}

string

小工具中顯示的文字。

integer

小工具中顯示的文字行數上限。如果文字超過指定的最大行數，系統會隱藏多餘的內容，並在「顯示更多」按鈕後方顯示。如果文字的行數等於或短於指定行數上限，則 顯示更多 系統就不會顯示按鈕。

預設值為 0，在這種情況下，系統會顯示所有內容。系統會忽略負值。 這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

圖片的 HTTPS 網址。

例如：

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

object (OnClick)

當使用者按一下圖片時，點擊就會觸發這個動作。

string

這張圖片的替代文字，用於無障礙功能。

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}

object (Action)

如果指定了這個 onClick，系統就會觸發動作。

object (OpenLink)

如有指定，這個 onClick 觸發公開連結動作。

object (Action)

當動作需要開啟連結時，外掛程式會觸發這個動作。不同於 openLink 可能需要與伺服器通訊才能取得連結因此，網路用戶端必須先完成一些前置作業，才能傳回公開連結動作回應。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

object (Card)

如有指定，系統會在點擊後將新卡片推送至資訊卡堆疊。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

object (OverflowMenu)

如有指定，這個 onClick 開啟溢位選單 這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

string

使用者點擊包含的元素或以其他方式啟動時，要叫用的自訂函式。

如需用途範例，請參閱 讀取表單資料。

object (ActionParameter)

動作參數清單。

enum (LoadIndicator)

指定在呼叫動作時顯示的載入指標。

boolean

指出表單值在動作後是否仍然存在。預設值為 false。

如果 true，表單值會在動作觸發後保留。如要讓使用者在動作處理期間做出變更，請設定 LoadIndicator敬上 到 NONE。適用對象 資訊卡訊息 您還需要將動作設為 ResponseType敬上 到 UPDATE_MESSAGE 並使用相同的 cardId 包含該動作的資訊卡

如果 false，系統會在動作觸發時清除表單值。如要防止使用者在處理動作時做出變更，請設定 LoadIndicator敬上 到 SPINNER。

enum (Interaction)

選用設定。開啟 對話方塊。

回應與使用者互動 (例如使用者點選資訊卡訊息中的按鈕) 時的動作。

如果未指定，應用程式會在 action — 照常開啟連結或執行函式。

透過指定 interaction，應用程式可以透過特殊的互動方式回應。舉例來說，將 interaction 設為 OPEN_DIALOG，應用程式就能開啟對話方塊。如果有指定，系統就不會顯示載入指標。如有指定外掛程式，系統會移除整張資訊卡，也不會在用戶端顯示任何內容。

這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

string

如果此處列出的小工具在叫用這個動作時沒有值，系統就會取消提交表單。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

boolean

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

{
  "key": string,
  "value": string
}

string

動作指令碼的參數名稱。

string

參數的值。

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

要開啟的網址。

enum (OpenAs)

如何開啟連結。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

enum (OnClose)

用戶端是否會在開啟連結後忘記連結，或是觀察連結，直到視窗關閉為止。

適用於 Google Workspace 外掛程式，不適用於 Google Chat 應用程式。

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

必要欄位。選單選項清單。

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

顯示在文字前方的圖示。

string

必要欄位。供使用者識別或描述項目的文字。

object (OnClick)

必要欄位。選取選單選項時叫用的動作。這個 OnClick 不得包含 OverflowMenu，任何指定 OverflowMenu 並停用了選單項目。

boolean

是否停用選單選項。預設值為 false。

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

string

選用設定。用於無障礙功能的圖示說明。如果未指定，則預設值為 Button 而不是每個 Pod 的名稱最佳做法是為圖示顯示的內容及功能 (如適用) 設定實用的說明。例如： A user's account portrait，或 Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat。

如果圖示位於 Button， altText 並在使用者將滑鼠遊標懸停在按鈕上時顯示說明文字。不過，如果按鈕也設定了 text，圖示的 altText 系統就會忽略。

enum (ImageType)

圖片套用的裁剪樣式。在某些情況下，套用 CIRCLE 裁剪功能會導致圖片繪製的大小大於內建圖示。

string

顯示 Google Workspace 提供的其中一個內建圖示。

舉例來說，如要顯示飛機圖示，請指定 AIRPLANE。如為巴士，請指定 BUS。

如需支援圖示的完整清單，請參閱「內建圖示」。

string

顯示由 HTTPS 網址代管的自訂圖示。

例如：

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

支援的檔案類型包括 .png 和 .jpg。

object (MaterialIcon)

顯示以下其中一個 Google Material 圖示。

例如，為了顯示 核取方塊圖示，請使用

"materialIcon": {
  "name": "check_box"
}

這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

先前指定的圖示名稱， Google Material 圖示 check_box。任何無效的名稱都會遭到捨棄，並替換成空字串，導致圖示無法顯示。

boolean

是否以填滿格式顯示圖示。預設值為否。

如要預覽其他圖示設定，請前往 Google 字型圖示 調整下方顯示的設定 自訂：

integer

圖示的筆劃粗細。請選擇 {100, 200, 300, 400, 500, 600, 700}。如未指定，預設值為 400。如指定任何其他值，則會使用預設值。

如要預覽不同的圖示設定，請前往 Google 字體圖示，然後調整「自訂」下方的設定。

integer

粗細和等級會影響符號的粗細。成績調整比權重調整得更精細，而且會對符號大小造成輕微影響。請選擇 {-25, 0, 200}。如未指定，則預設值為 0。如果指定任何其他值，則會使用預設值。

如要預覽其他圖示設定，請前往 Google 字型圖示 調整下方顯示的設定 自訂：

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

object (Icon)

淘汰，改用 startIcon。

object (Icon)

顯示在文字前方的圖示。

string

上方文字 text。一律截斷。

string

必要欄位。主要文字。

支援簡易格式設定。如要進一步瞭解如何設定文字格式，請參閱 設定 Google Chat 應用程式的文字格式 和 在 Google Workspace 外掛程式中設定文字格式。

boolean

文字換行設定。如果 true，文字會換行並顯示至多行。否則文字會截斷。

僅適用於 text，不是 topLabel 和 bottomLabel。

string

下方會顯示的文字 text。一律會包裝。

object (OnClick)

使用者點選 topLabel 或 bottomLabel 時，系統會觸發這項動作。

object (Button)

使用者只要按一下按鈕，即可觸發動作。

object (SwitchControl)

這個切換小工具可供使用者點選，以變更狀態並觸發動作。

object (Icon)

文字後方顯示的圖示。

支援 內建功能 和 自訂 圖示。

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

按鈕中顯示的文字。

object (Icon)

按鈕中顯示的圖示。如果兩者皆是 icon 和 text 設定後，圖示會顯示在文字前面。

object (Color)

選用設定。按鈕的顏色。如果已設定，則按鈕位於 type 設為 FILLED 和顏色的 text 和 icon 為了方便閱讀，系統會將欄位設為對比色彩。舉例來說，如果按鈕顏色設為藍色，則按鈕中的所有文字或圖示都會設為白色。

如要設定按鈕顏色，請為 red、green 和 blue 欄位指定值。根據 RGB 顏色值，這個值必須是介於 0 至 1 之間的浮點數，其中 0 (0/255) 代表缺少顏色和 1 (255/255) 代表色彩的最大強度。

例如，以下程式碼會將顏色設為最高強度的紅色：

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha 欄位顏色不適用於按鈕顏色。如有指定，系統會忽略這個欄位。

object (OnClick)

必要欄位。使用者按下按鈕時要執行的動作，例如開啟超連結或執行自訂函式。

boolean

如果 true，按鈕會處於閒置狀態，且不會回應使用者動作。

string

用於無障礙功能的替代文字。

設定說明文字，讓使用者瞭解按鈕的功能。舉例來說，如果按鈕會開啟超連結，您可以寫：「開啟新的瀏覽器分頁，並前往 Google Chat 開發人員說明文件： https://developers.google.com/workspace/chat".

enum (Type)

選用設定。按鈕類型，如果未設定，按鈕類型會預設為 OUTLINED。如果 color 欄位設定後，系統就會強制將按鈕類型 FILLED 並忽略這個欄位設定的任何值。

這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

顏色中的紅色量，值介於 [0, 1] 之間。

number

間隔 [0, 1] 內色彩的綠色量。

number

以色彩呈現的藍色量為間隔 [0, 1] 的值。

number

應套用至像素的色彩比例。也就是說，最終像素顏色會由這個方程式定義：

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

也就是說，值為 1.0 對應於純色，而值為 0.0 則對應於完全透明的顏色。這會使用包裝函式訊息，而非簡單的浮點純量，因此能夠區分預設值和未設定的值。如果省略，此顏色物件會算繪為單色 (如同 Alpha 值已明確指定 1.0 值)。

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

在表單輸入事件中，系統用來識別切換鈕小工具的名稱。

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

string

使用者輸入的值，會做為表單輸入事件的一部分傳回。

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

boolean

時間 true，已選取切換按鈕。

object (Action)

切換狀態時要執行的動作，例如要執行的函式。

enum (ControlType)

切換鈕在使用者介面中的顯示方式。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

按鈕陣列。

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}

string

文字輸入事件在表單輸入事件中識別的名稱。

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

string

顯示在使用者介面文字輸入欄位上方的文字。

指定文字，協助使用者輸入應用程式所需的資訊。舉例來說，如要詢問某人的名字，但明確需要對方的姓氏，請輸入 surname 而不是 name。

若符合以下情況，則為必要欄位： hintText 未指定，如果不是，請選用。

string

顯示在文字輸入欄位下方的文字，旨在提示使用者輸入特定值。這段文字一律會顯示。

若符合以下情況，則為必要欄位： label 未指定，如果不是，請選用。

string

使用者輸入的值，做為表單輸入事件的一部分傳回。

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

enum (Type)

文字輸入欄位在使用者介面中的顯示方式。例如，欄位是單行還是多行。

object (Action)

文字輸入欄位發生變更時的處理方式。例如使用者在欄位中新增或刪除文字。

可採取的行動包括執行自訂函式或開啟 對話方塊 。

object (Suggestions)

使用者可輸入的建議值。當使用者點選文字輸入欄位時，系統就會顯示這些值。使用者輸入內容時，系統會根據使用者輸入的內容，動態篩選建議值。

舉例來說，程式設計語言的文字輸入欄位可能會建議使用 Java、JavaScript、Python 和 C++。使用者開始輸入內容時 Jav，要顯示的建議篩選器清單 Java 和 JavaScript。

建議值可協助引導使用者輸入應用程式能夠理解的值。某些使用者可能會輸入 JavaScript javascript 和其他來源 java script。建議操作 JavaScript 能夠標準化使用者與應用程式的互動方式

如果有指定的話 TextInput.type 一律 SINGLE_LINE (即使設為 MULTIPLE_LINE。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

object (Action)

選用設定。指定當文字輸入欄位向互動使用者建議時，要採取的動作。

如果未指定，建議是由 initialSuggestions 並由用戶端處理

如有指定，應用程式會採取此處指定的動作，例如執行自訂函式。

適用於 Google Workspace 外掛程式，但不適用於 Google Chat 應用程式。

object (Validation)

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

string

文字欄位空白時，在文字輸入欄位中顯示的文字。使用這段文字提示使用者輸入值。例如 Enter a number from 0 to 100。

這項功能適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

Action

Navigation

推送或更新顯示的資訊卡。

Card

卡片堆疊會將卡片推送至卡片堆疊上。

Card

資訊卡堆疊會以新資訊卡更新頂端的資訊卡，並保留已填妥的表單欄位值。如果不是相等的欄位，則會捨棄該值。

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

文字輸入欄位中，用於自動完成建議的建議清單。

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

建議輸入內容欄位的值。這與使用者自行輸入的內容相同。

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

enum (InputType)

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

必要欄位。用於識別表單輸入事件中的選取輸入內容的名稱。

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

string

顯示在使用者介面的選取輸入欄位上方的文字。

指定文字，協助使用者輸入應用程式所需的資訊。舉例來說，如果使用者從下拉式選單中選取工作單據的緊急程度，標籤可能會是「緊急程度」或「選取緊急程度」。

enum (SelectionType)

向使用者顯示在 SelectionInput 小工具中項目的類型。選取類型支援不同類型的互動。舉例來說，使用者可以勾選一或多個核取方塊，但只能從下拉式選單中選取一個值。

object (SelectionItem)

可選取項目的陣列。例如圓形按鈕或核取方塊的陣列。最多可支援 100 個項目。

object (Action)

如有指定，系統會在選項變更時提交表單。如未指定，您必須另外指定用來提交表單的按鈕。

如要進一步瞭解如何使用表單輸入內容，請參閱「接收表單資料」。

integer

如果是複選選單，使用者可以選取的項目數量上限。不得少於 1 個項目。如果未指定，則預設為 3 個項目。

integer

如果是複選選單，使用者在應用程式查詢自動完成前輸入的文字字元數，會在選單中顯示建議項目。

如未指定，靜態資料來源會預設為 0 個字元，外部資料來源則為 3 個字元。

object (Validation)

下拉式選單的驗證選項輸入欄位。

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

object (Action)

外部資料來源，例如關聯資料集。

object (PlatformDataSource)

Google Workspace 的資料來源。

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

供使用者識別或描述項目的文字。

string

與此項目相關聯的值。用戶端應將此值做為表單輸入值。

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

boolean

該項目是否預設為選取。如果選項輸入只接受一個值 (例如圓形按鈕或下拉式選單)，則只要為一個項目設定這個欄位即可。

string

如果是複選的選單，項目、 text ] 欄位。支援 PNG 和 JPEG 檔案。必須是 HTTPS 網址。例如 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。

string

如果是複選選單，文字說明或標籤會顯示在項目下方 text ] 欄位。

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

所有 Google Workspace 應用程式共用的資料來源，例如 Google Workspace 機構的使用者。

object (HostAppDataSourceMarkup)

Google Workspace 代管應用程式專屬的資料來源，例如 Google Chat 中的聊天室。

這個欄位支援 Google API 用戶端程式庫，但 Cloud 用戶端程式庫並未提供。詳情請參閱： 安裝用戶端程式庫。

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

Google Chat 的資料來源。

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

使用者所屬的 Google Chat 聊天室。

{
  "defaultToCurrentSpace": boolean
}

boolean

如果設為 true，系統預設會選取目前的 Google Chat 聊天室做為項目。

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

string

這是 DateTimePicker 以便在表單輸入事件中加以識別

如要進一步瞭解如何使用表單輸入功能，請參閱 接收表單資料。

string

提示使用者輸入日期、時間或日期和時間的文字。舉例來說，如果使用者要安排預約，請使用 Appointment date 或 Appointment date and time 等標籤。

enum (DateTimePickerType)

小工具是否支援輸入日期、時間，或日期和時間。

string (int64 format)

小工具中顯示的預設值 (以毫秒為單位，自 Unix 紀元時間。

根據挑選器類型指定值 ( DateTimePickerType):

• DATE_AND_TIME ：以世界標準時間為準的日曆日期和時間。舉例來說，如要代表世界標準時間 2023 年 1 月 1 日中午 12 點，請輸入 1672574400000。
• DATE_ONLY ：日曆上的日期 (世界標準時間 00:00:00)。舉例來說，如要代表 2023 年 1 月 1 日，請使用 1672531200000。
• TIME_ONLY ：世界標準時間。舉例來說，如要表示下午 12 點，請使用 43200000 (或 12 * 60 * 60 * 1000)。

integer

代表時區與世界標準時間的差距數字，以分鐘為單位。如果已設定，valueMsEpoch 會顯示在指定時區。如未設定，這個值會預設為使用者的時區設定。

object (Action)

在使用者點選時觸發 儲存 或 清除 從 DateTimePicker 存取 API

object (Validation)

適用於 Google Chat 應用程式和 Google Workspace 外掛程式。

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

格線標題中顯示的文字。

object (GridItem)

要在格狀檢視中顯示的項目。

object (BorderStyle)

要套用至每個格線項目的框線樣式。

integer

格狀檢視中顯示的欄數。如未指定這個欄位，系統會採用預設值，具體取決於格線的顯示位置 (對話方塊與隨播廣告)。

object (OnClick)

每個個別格線項目都會重複使用這個回呼，但會將項目清單中的項目 ID 和索引加進回呼的參數。

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

這個格線項目的使用者指定 ID。這個 ID 會傳回父項網格的 onClick 回呼參數。

object (ImageComponent)

格線項目中顯示的圖片。

string

格線項目的標題。

string

格線項目的副標題。

enum (GridItemLayout)

格線項目要使用的版面配置。

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

圖片網址。

string

圖片的無障礙標籤。

object (ImageCropStyle)

要套用至圖片的裁剪樣式。

object (BorderStyle)

要套用至圖片的框線樣式。

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

裁剪類型。

number

如果裁剪類型為 RECTANGLE_CUSTOM，則使用的顯示比例。

舉例來說，以下說明如何套用 16:9 的顯示比例：

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

邊框類型。

object (Color)

當類型為 BORDER_TYPE_STROKE 時要使用的顏色。

如要設定筆劃顏色，請指定 red, green和 blue 只要使用來自這些領域的 小型資料集訓練即可根據 RGB 顏色值，這個值必須是介於 0 至 1 之間的浮點數，其中 0 (0/255) 代表缺少顏色和 1 (255/255) 代表色彩的最大強度。

例如，下列指令會在最大強度將顏色設為紅色：

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha 欄位不支援筆劃顏色。如有指定，系統會忽略這個欄位。

integer

邊框的圓角半徑。

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

資料欄陣列。單一資訊卡或對話方塊中最多可包含 2 欄。

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

指定資料欄的寬度填滿。

enum (HorizontalAlignment)

指定小工具要對齊資料欄的左側、右側或中央。

enum (VerticalAlignment)

指定小工具要對齊資料欄的頂端、底部或中央。

object (Widgets)

資料欄中所含小工具的陣列。小工具會按指定順序顯示。

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph

object (Image)

Image

object (DecoratedText)

DecoratedText

object (ButtonList)

ButtonList

object (TextInput)

TextInput

object (SelectionInput)

SelectionInput 小工具。

object (DateTimePicker)

DateTimePicker

object (ChipList)

ChipList 適用於 Google Chat 應用程式，但不適用於 Google Workspace 外掛程式。

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

指定的方塊清單版面配置。

object (Chip)

一組方塊。

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

圖示圖片。如果兩者皆是 icon 和 text 設定後，圖示會顯示在文字前面。

string

方塊中顯示的文字。

object (OnClick)

選用設定。使用者點選方塊時要執行的動作 (例如開啟超連結或執行自訂函式)。

boolean

方塊是否處於有效狀態，並回應使用者操作。預設為 true。已淘汰，使用 disabled 。

boolean

方塊是否處於閒置狀態，並忽略使用者動作。預設為 false。

string

用於無障礙功能的替代文字。

設定說明文字，讓使用者瞭解方塊的用途。舉例來說，如果方塊會開啟超連結，請寫下「開啟新的瀏覽器分頁，並前往 Google Chat 開發人員說明文件 (網址為 https://developers.google.com/workspace/chat")」

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

展開和收合按鈕的水平對齊。

object (Button)

選用設定。定義可自訂的按鈕，用於展開該部分。必須設定展開按鈕和 收合按鈕 欄位。只有一組欄位才會生效。如未設定這個欄位，系統會使用預設按鈕。

object (Button)

選用設定。定義可收合區段的按鈕。必須設定展開按鈕和 收合按鈕 欄位。只有一組欄位才會生效。如未設定這個欄位，系統會使用預設按鈕。

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

顯示為動作選單項目的標籤。

object (OnClick)

onClick 這個動作。

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

固定頁尾的主要按鈕。按鈕必須是已設定文字和顏色的文字按鈕。

object (Button)

固定頁尾的次要按鈕。按鈕必須是已設定文字和顏色的文字按鈕。如果 secondaryButton 您也必須設定 primaryButton。