Cards v2

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 應用程式。

string

必要欄位。資訊卡標題。標題的高度固定，如果同時指定標題和副標題，兩者各佔一行。如果只指定標題，則會佔用兩行。

string

資訊卡標題的副標題。如果指定，會顯示在 title 下方的單獨一行。

enum (ImageType)

用於裁剪圖片的形狀。

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

string

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

string

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

string

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

object (Widget)

該區段中的所有小工具。至少要包含一個小工具。

boolean

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

可收合的區塊會隱藏部分或所有小工具，但使用者可以點選「顯示更多」展開區塊，顯示隱藏的小工具。使用者可以按一下「顯示較少」，再次隱藏小工具。

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

integer

即使部分內容已收合，仍會顯示的不可收合小工具數量。

舉例來說，如果某個區段包含五個小工具，且 uncollapsibleWidgetsCount 設為 2，系統一律會顯示前兩個小工具，並預設收合後三個小工具。只有在 collapsible 為 true 時，系統才會將 uncollapsibleWidgetsCount 納入考量。

object (CollapseControl)

(選用步驟) 定義區段的展開和收合按鈕。只有在可收合的區塊中，才會顯示這個按鈕。如果未設定這個欄位，系統會使用預設按鈕。

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 (Carousel)

輪播包含一系列巢狀小工具。舉例來說，這是包含兩個文字段落的輪轉介面 JSON 表示法。

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

object (ChipList)

方塊清單。

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

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

string

小工具中顯示的文字。

integer

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

預設值為 0，此時會顯示所有內容。系統會忽略負值。

enum (TextSyntax)

文字的語法。如未設定，系統會將文字轉譯為 HTML。

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

string

圖片所在的 HTTPS 網址。

例如：

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

object (OnClick)

使用者點按圖片時，點擊動作會觸發這項動作。

string

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

object (Action)

如果指定了這個屬性，系統會透過 onClick 觸發動作。

object (OpenLink)

如果指定了這個值，onClick 會觸發開啟連結動作。

object (Action)

當動作需要開啟連結時，外掛程式會觸發這項動作。這與上述的 openLink 不同，因為這需要與伺服器通訊才能取得連結。因此，網頁用戶端必須先完成一些準備工作，才能收到開啟連結動作的回應。

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

object (Card)

點按後，系統會將新卡片推送至卡片堆疊 (如有指定)。

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

object (OverflowMenu)

如果指定此項目，則會開啟溢位選單。onClick

string

在含有元素的項目遭到點選或以其他方式啟用時，要叫用的自訂函式。

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

object (ActionParameter)

動作參數清單。

enum (LoadIndicator)

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

boolean

指出表單值是否會在動作完成後保留。預設值為 false。

如果為 true，觸發動作後表單值會保留。如要讓使用者在處理動作時進行變更，請將 LoadIndicator 設為 NONE。如要使用 Chat 應用程式中的資訊卡訊息，您也必須將動作的 ResponseType 設為 UPDATE_MESSAGE，並使用包含該動作的資訊卡中的相同 cardId。

如果為 false，系統會在觸發動作時清除表單值。如要防止使用者在處理動作時進行變更，請將 LoadIndicator 設為 SPINNER。

enum (Interaction)

(選用步驟) 開啟對話方塊時為必填屬性。

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

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

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

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

string

(選用步驟) 請在這個清單中填入這個動作需要的小工具名稱，才能有效提交。

如果這個動作叫用時，這裡列出的小工具沒有值，表單提交作業就會中止。

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

boolean

(選用步驟) 如果為 true，則這項動作會將所有小工具視為必要。

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

string

動作指令碼的參數名稱。

string

參數的值。

string

要開啟的網址。

enum (OpenAs)

如何開啟連結。

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

enum (OnClose)

無論用戶端在開啟連結後忘記連結，還是觀察連結直到視窗關閉。

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

object (OverflowMenuItem)

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

object (Icon)

顯示在文字前方的圖示。

string

必要欄位。向使用者識別或說明商品的文字。

object (OnClick)

必要欄位。選取選單選項時執行的動作。這個 OnClick 不得包含 OverflowMenu，任何指定的 OverflowMenu 都會遭到捨棄，且選單項目會停用。

boolean

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

string

(選用步驟) 無障礙圖示的說明。如未指定，則提供預設值 Button。最佳做法是為圖示顯示的內容設定實用說明，並視需要說明圖示的功能。例如 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 Icons。

舉例來說，如要顯示核取方塊圖示，請使用

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

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

string

Google Material Icon 中定義的圖示名稱，例如 check_box。系統會捨棄所有無效名稱，並替換成空白字串，導致圖示無法顯示。

boolean

圖示是否會填滿。預設值為 false。

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

integer

圖示的筆觸粗細。請從 {100、200、300、400、500、600、700} 中選擇。如未提供，預設值為 400。如果指定其他值，系統會使用預設值。

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

integer

符號的粗細會受到權重和等級影響。調整級別比調整粗細更精細，對符號大小的影響較小。請從 {-25, 0, 200} 中選擇。如未提供，預設值為 0。如果指定其他值，系統會使用預設值。

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

object (Icon)

已淘汰，改用 startIcon。

object (Icon)

顯示在文字前方的圖示。

enum (VerticalAlignment)

(選用步驟) 開始圖示的垂直對齊方式。如未設定，圖示會垂直置中。

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

string

顯示在 text 上方的文字。一律會截斷。

object (TextParagraph)

TextParagraph 的等效項目 topLabel。一律會截斷。可進行比 topLabel 更複雜的格式設定。

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

string

必要欄位。主要文字。

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

object (TextParagraph)

TextParagraph 的等效項目 text。可進行比 text 更複雜的格式設定。

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

boolean

自動換行設定。如為 true，文字會換行並顯示在多行中。否則文字會遭到截斷。

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

string

顯示在 text 下方的文字。一律換行。

object (TextParagraph)

TextParagraph 的等效項目 bottomLabel。一律換行。可進行比 bottomLabel 更複雜的格式設定。

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

object (OnClick)

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

object (Button)

使用者可點選這個按鈕來觸發動作。

object (SwitchControl)

使用者可以點選切換鈕小工具來變更狀態及觸發動作。

object (Icon)

文字後方顯示的圖示。

支援內建和自訂圖示。

string

按鈕內顯示的文字。

object (Icon)

按鈕內顯示的圖示。如果同時設定 icon 和 text ，圖示會顯示在文字前方。

object (Color)

(選用步驟) 按鈕的顏色。如果已設定，按鈕 type 會設為 FILLED，而 text 和 icon 欄位的顏色會設為對比色，方便閱讀。舉例來說，如果按鈕顏色設為藍色，按鈕中的任何文字或圖示都會設為白色。

如要設定按鈕顏色，請為 red、green 和 blue 欄位指定值。值必須是介於 0 和 1 之間的浮點數，以 RGB 顏色值為準，其中 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，且系統會忽略為這個欄位設定的任何值。

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)。

string

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

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

string

使用者輸入的值，會以表單輸入事件的形式傳回。

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

boolean

如果選取 true，則會選取切換開關。

object (Action)

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

enum (ControlType)

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

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

object (Button)

按鈕陣列。

string

表單輸入事件中用於識別文字輸入內容的名稱。

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

string

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

指定有助於使用者輸入應用程式所需資訊的文字。舉例來說，如果您要詢問對方的姓名，但特別需要對方的姓氏，請寫下 surname ，而不是 name。

如果未指定 hintText，則為必要欄位。否則為選填。

string

顯示在文字輸入欄位下方的文字，提示使用者輸入特定值，藉此提供協助。這段文字會一直顯示。

如果未指定 label，則為必要欄位。否則為選填。

string

使用者輸入的值，會以表單輸入事件的形式傳回。

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

enum (Type)

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

object (Action)

當文字輸入欄位發生變更時，應執行的動作。例如使用者在欄位中新增或刪除文字。

可執行的動作包括執行自訂函式，或在 Google Chat 中開啟對話方塊。

object (Suggestions)

使用者可輸入的建議值。使用者點按文字輸入欄位時，系統會顯示這些值。使用者輸入時，系統會動態篩選建議值，只顯示與使用者輸入內容相符的值。

舉例來說，程式設計語言的文字輸入欄位可能會建議 Java、JavaScript、Python 和 C++。當使用者開始輸入「J」時，建議清單會經過篩選，只顯示「Java」和「JavaScript」。JavJavaJavaScript

建議值可引導使用者輸入應用程式可解讀的值。提到 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

推送、彈出或更新卡片。

Google Chat 外掛程式。

Card

將卡片推送到卡片堆疊。

如果是 Google Chat 中的對話方塊，則會開啟或更新對話方塊。

Card

更新頂端卡片，顯示新卡片，並保留已填寫的表單欄位值。如果欄位不對等，系統會捨棄值。

如果是 Google Chat 中的對話方塊，則會開啟或更新對話方塊。

object (SuggestionItem)

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

string

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

integer

指定文字輸入小工具的字元限制。請注意，這項屬性僅適用於文字輸入，其他小工具會忽略這項屬性。

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

enum (InputType)

指定輸入小工具的類型。

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

string

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

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

string

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

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

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

如果指定，表單會在選取內容變更時提交。如未指定，則必須指定提交表單的按鈕。

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

integer

如果是多選式選單，使用者輸入的文字字元數達到這個值後，選單就會傳回建議的選取項目。

如未設定，多選式選單會使用下列預設值：

• 如果選單使用 SelectionInput 項目靜態陣列，預設為 0 個字元，並立即從陣列填入項目。
• 如果選單使用動態資料來源 (multi_select_data_source)，系統預設會在使用者輸入 3 個字元後，查詢資料來源並傳回建議項目。

integer

如果是多選選單，這是使用者可選取的項目數量上限。最小值為 1 個項目。如未指定，預設為 3 個項目。

object (Action)

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

object (PlatformDataSource)

Google Workspace 的資料來源。

string

向使用者識別或說明商品的文字。

string

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

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

boolean

項目是否預設為選取狀態。如果選取輸入內容只接受一個值 (例如圓形按鈕或下拉式選單)，請只為一個項目設定這個欄位。

string

如果是多選式選單，則為顯示在項目text欄位下方的文字說明或標籤。

string

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

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

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

object (ChatClientDataSourceMarkup)

Google Chat 的資料來源。

object (SpaceDataSource)

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

boolean

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

string

表單輸入事件中識別 DateTimePicker 的名稱。

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

string

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

enum (DateTimePickerType)

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

string (int64 format)

小工具中顯示的預設值，以自 Unix Epoch 時間起算的毫秒數為單位。

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

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

integer

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

object (Action)

使用者在 DateTimePicker 介面中點選「儲存」或「清除」時觸發。

string

顯示在格線標題中的文字。

object (GridItem)

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

object (BorderStyle)

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

integer

要在格線中顯示的欄數。如未指定這個欄位，系統會使用預設值，而預設值會因格線顯示位置 (對話方塊與隨播廣告) 而異。

object (OnClick)

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

string

這個格線項目的使用者指定 ID。這個 ID 會在上層格線的 onClick 回呼參數中傳回。

object (ImageComponent)

顯示在格狀項目中的圖片。

string

格線項目的標題。

string

格線項目的子標題。

enum (GridItemLayout)

用於格線項目的版面配置。

string

圖片網址。

string

圖片的無障礙標籤。

object (ImageCropStyle)

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

object (BorderStyle)

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

enum (ImageCropType)

裁剪類型。

number

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

舉例來說，以下是套用 16:9 長寬比的方法：

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

enum (BorderType)

框線類型。

object (Color)

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

如要設定筆觸顏色，請為 red、green 和 blue 欄位指定值。值必須是介於 0 和 1 之間的浮點數，以 RGB 顏色值為準，其中 0 (0/255) 代表沒有顏色， 1 (255/255) 代表顏色強度最高。

舉例來說，下列程式碼會將顏色設為最高強度的紅色：

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

「筆觸顏色」無法使用「alpha」欄位。如果指定這個欄位，系統會忽略。

integer

邊框的圓角半徑。

object (Column)

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

enum (HorizontalSizeStyle)

指定資料欄填滿卡片寬度的方式。

enum (HorizontalAlignment)

指定小工具在欄中靠左、靠右或置中對齊。

enum (VerticalAlignment)

指定小工具是否要靠上、靠下或置中對齊資料欄。

object (Widgets)

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

object (TextParagraph)

TextParagraph 小工具。

object (Image)

Image 小工具。

object (DecoratedText)

DecoratedText 小工具。

object (ButtonList)

ButtonList 小工具。

object (TextInput)

TextInput 小工具。

object (SelectionInput)

SelectionInput 小工具。

object (DateTimePicker)

DateTimePicker 小工具。

object (ChipList)

ChipList 小工具。

enum (Layout)

指定方塊清單版面配置。

object (Chip)

晶片陣列。

object (Icon)

圖示圖片。如果同時設定 icon 和 text ，圖示會顯示在文字前方。

string

方塊內顯示的文字。

object (OnClick)

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

boolean

晶片是否處於啟用狀態，並回應使用者動作。預設值為 true。已淘汰，請改用 disabled。

boolean

晶片是否處於非使用中狀態，並忽略使用者動作。預設值為 false。

string

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

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

object (CarouselCard)

輪轉介面中包含的資訊卡清單。

object (NestedWidget)

輪轉介面資訊卡中顯示的小工具清單。小工具會按照指定順序顯示。

object (NestedWidget)

輪轉介面資訊卡底部會顯示小工具清單。小工具會按照指定順序顯示。

object (TextParagraph)

文字段落小工具。

object (ButtonList)

按鈕清單小工具。

object (Image)

圖片小工具。

enum (HorizontalAlignment)

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

object (Button)

(選用步驟) 定義可自訂按鈕，展開該部分。expandButton 和 collapseButton 欄位都必須設定。如果只設定一個欄位，不會生效。如果未設定這個欄位，系統會使用預設按鈕。

object (Button)

(選用步驟) 定義可自訂的按鈕，用來收合該部分。expandButton 和 collapseButton 欄位都必須設定。如果只設定一個欄位，不會生效。如果未設定這個欄位，系統會使用預設按鈕。

string

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

object (OnClick)

這個待辦事項的onClick動作。

object (Button)

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

object (Button)

固定式頁尾的次要按鈕。按鈕必須是文字按鈕，且已設定文字和顏色。如果設定 secondaryButton，就必須一併設定 primaryButton。