Card Service

卡片服務

這項服務可讓指令碼設定及建構 UI 的卡片和小工具元件與行為。使用這項服務建構的 UI 結構會自動在電腦和行動裝置上提供，因此您不必分別開發兩者的 UI。

您可以使用 CardService 為 Google Workspace 外掛程式和 Google Chat 應用程式訊息建構以資訊卡為基礎的 UI。

類別

名稱	簡短說明
Action	可在 UI 元素中啟用互動功能的操作。
ActionResponse	可從回呼函式 (例如表單回應處理常式) 傳回的回應物件，用於在用戶端執行一或多項動作。
ActionResponseBuilder	ActionResponse 物件的建構工具。
ActionStatus	這個類別代表呼叫或提交對話方塊的要求狀態。
Attachment	代表外掛程式建立的附件。
AuthorizationAction	授權動作，使用者點選後會前往 AuthorizationUrl。
AuthorizationException	可傳回的錯誤，用於觸發向使用者顯示授權卡。
BorderStyle	代表可套用至小工具的完整邊框樣式類別。
BorderType	列舉代表可套用至小工具的邊框類型。
Button	所有按鈕的基礎類別。
ButtonSet	保存一組以資料列形式顯示的 Button 物件。
CalendarEventActionResponse	代表回應，可因應使用者在 UI 中執行的動作 (例如點選按鈕)，變更使用者目前編輯的日曆活動。
CalendarEventActionResponseBuilder	CalendarEventActionResponse 物件的建構工具。
Card	代表 UI 中單一檢視畫面的內容資訊卡。
CardAction	可點選的選單項目，會新增至資訊卡標題選單。
CardBuilder	Card 物件的建構工具。
CardHeader	Card 的標頭。
CardSection	資訊卡區段會保留小工具群組，並在群組之間提供視覺化分隔。
CardService	CardService 可建立通用卡片，用於各種 Google 擴充性產品，例如 Google Workspace 外掛程式。
CardWithId	CardWithId 物件的建構工具。
Carousel	輪播 (又稱滑桿) 會以投影片形式輪流顯示小工具清單，並提供按鈕，方便使用者前往上一個或下一個小工具。
CarouselCard	可做為輪轉介面項目的資訊卡。
ChatActionResponse	這個類別代表即時通訊應用程式可用來設定回應發布方式的參數。
ChatClientDataSource	使用多重選取選單的 SelectionInput 小工具，以及 Google Chat 的資料來源。
ChatResponse	Google Chat 中卡片訊息的回覆物件。
ChatResponseBuilder	ChatResponse 物件的建構工具。
ChatSpaceDataSource	資料來源，可做為多選選單的選項，填入 Google Chat 聊天室。
Chip	含有圖示和文字標籤的 Chip。
ChipList	包含一組 Chip 物件，這些物件會顯示在同一列中，並換行至下一行，以進行水平捲動。
ChipListLayout	指定 ChipList 版面配置的列舉。
CollapseControl	可自訂的收合和展開控制項。
Column	資料欄。
Columns	Columns 小工具最多可在資訊卡或對話方塊中顯示 2 欄。
CommonDataSource	所有 Google Workspace 應用程式共用的資料來源。
CommonWidgetAction	定義不涉及評估的動作，例如更新小工具顯示狀態。
ComposeActionResponse	回呼方法可能會傳回的回應物件，適用於 Gmail 外掛程式中的撰寫動作。
ComposeActionResponseBuilder	ComposeActionResponse 物件的建構工具。
ComposedEmailType	列舉值，用於指定撰寫的電子郵件是獨立郵件還是回覆草稿。
Condition	用來執行事件動作的條件，是 CEL 運算式驗證的一部分。
ContentType	列舉值，用於指定 UpdateDraftActionResponse 生成內容的內容類型。
DatePicker	可輸入日期的輸入欄位。
DateTimePicker	使用者可輸入日期和時間的輸入欄位。
DecoratedText	顯示文字的小工具，可選擇是否要加上裝飾。
Dialog	詳情請參閱 Google Chat 說明文件中的「開啟互動式對話方塊」。
DialogAction	DialogAction 物件的建構工具。
DisplayStyle	定義資訊卡顯示樣式的列舉。
Divider	水平分隔線。
DriveItemsSelectedActionResponse	代表在選取雲端硬碟項目時，因應 UI 中執行的動作 (例如點按按鈕) 而對雲端硬碟所做的變更。
DriveItemsSelectedActionResponseBuilder	DriveItemsSelectedActionResponse 物件的建構工具。
EditorFileScopeActionResponse	根據 UI 中執行的動作，變更編輯器 (例如 Google 文件、試算表或簡報)。
EditorFileScopeActionResponseBuilder	EditorFileScopeActionResponse 物件的建構工具。
EventAction	符合 CEL 運算式驗證條件時要執行的 EventAction。
ExpressionData	用於評估運算式的運算式資料
ExpressionDataAction	對 CEL 運算式驗證採取動作。
ExpressionDataActionType	列舉代表運算式資料動作的類型。
ExpressionDataCondition	代表 CEL 運算式驗證結果。
ExpressionDataConditionType	代表 CEL 運算式是否成功評估。
FixedFooter	顯示在 Card 底部的固定頁尾。
Grid	有條不紊的格線，可顯示格線項目集合。
GridItem	使用者在格線小工具中互動的項目。
GridItemLayout	這個列舉會定義 GridItem 的圖片和文字樣式。
HorizontalAlignment	列舉，指定小工具的水平對齊方式。
HorizontalSizeStyle	這個列舉會設定小工具填滿資料欄空間的方式。
HostAppDataSource	如果 SelectionInput 小工具使用多選選單，則資料來源必須是 Google Workspace 應用程式。
Icon	預先定義的圖示，可用於各種 UI 物件，例如 ImageButton 或 DecoratedText 小工具。
IconImage	預先定義的圖示、Material Design 圖示，或來自網址的圖示，並可自訂裁剪樣式。
Image	顯示單張圖片的小工具。
ImageButton	顯示圖片的 ImageButton。
ImageButtonStyle	指定 ImageButton 樣式的列舉。
ImageComponent	可新增至格狀項目的圖片元件。
ImageCropStyle	這個類別代表可套用至圖片元件的裁剪樣式。
ImageCropType	這個列舉代表套用至圖片元件的裁剪樣式。
ImageStyle	定義圖片裁剪樣式的列舉。
InputType	定義小工具輸入類型的列舉。
Interaction	列舉型別，指定如何回應與使用者的互動，例如使用者點選資訊卡訊息中的按鈕。
KeyValue	這個類別已淘汰。
LinkPreview	卡片動作，可在主機應用程式中顯示連結預覽資訊卡和智慧型方塊。
LoadIndicator	列舉型別，指定處理 Action 時要顯示的載入或進度指標類型。
MaterialIcon	支援所有 Google 字型圖示的物件。
Navigation	控制卡片導覽的輔助物件。
Notification	使用者與 UI 元素互動後，系統顯示的通知。
OnClose	列舉，用於指定關閉透過 OpenLink 開啟的網址時要執行的動作。
OpenAs	列舉，指定如何開啟網址。
OpenLink	代表開啟連結的動作，並提供一些選項。
OverflowMenu	包含顯示在彈出式選單中的 OverflowMenuItem 物件清單。
OverflowMenuItem	含有圖示和文字標籤的 OverflowMenuItem。
PlatformDataSource	使用多選單的 SelectionInput 小工具，以及 Google Workspace 的資料來源。
ResponseType	列舉代表 Chat 應用程式的回應類型。
SelectionInput	輸入欄位，可從一組預先定義的選項中選擇。
SelectionInputType	使用者可選取的項目格式。
Status	代表狀態碼的列舉。
Suggestions	自動完成建議，可輔助 TextInput 小工具。
SuggestionsResponse	可從建議回呼函式傳回的回應物件。
SuggestionsResponseBuilder	SuggestionsResponse 物件的建構工具。
Switch	可開啟或關閉的 UI 元素。
SwitchControlType	Switch 小工具控制項的類型。
TextButton	附有文字標籤的 TextButton。
TextButtonStyle	指定 TextButton 樣式的列舉。
TextInput	可接受文字輸入的輸入欄位小工具。
TextParagraph	顯示文字並支援基本 HTML 格式的小工具。
TimePicker	使用者可透過這個輸入欄位輸入時間。
Trigger	觸發條件：根據動作規則 ID 執行 CEL 表達式驗證小工具事件動作。
UniversalActionResponse	方法可能會傳回的回應物件，用於建立通用動作。
UniversalActionResponseBuilder	UniversalActionResponse 物件的建構工具。
UpdateDraftActionResponse	代表更新使用者目前編輯的電子郵件草稿的動作。
UpdateDraftActionResponseBuilder	UpdateDraftActionResponse 物件的建構工具。
UpdateDraftBccRecipientsAction	更新電子郵件草稿的密件副本收件者。
UpdateDraftBodyAction	更新電子郵件草稿內文。
UpdateDraftBodyType	指定 UpdateDraftBodyAction 類型的列舉值。
UpdateDraftCcRecipientsAction	更新電子郵件草稿的副本收件者。
UpdateDraftSubjectAction	更新電子郵件草稿的主旨行。
UpdateDraftToRecipientsAction	更新電子郵件草稿的收件者。
UpdateVisibilityAction	更新資訊卡小工具的顯示設定，使其顯示或隱藏。
UpdatedWidget	更新後的小工具回應。
Validation	定義所附加小工具驗證規則的物件。
VariableButtonSize	表示變數挑選器按鈕大小的列舉。
VerticalAlignment	這個列舉會設定資料欄中小工具的垂直對齊方式。
Visibility	列舉代表小工具的顯示狀態。
Widget	可新增至 Card 的所有小工具的基礎類別。
WorkflowDataSource	如果是 SelectionInput、DateTimePicker 或 TextInput 小工具，資料來源來自 Google Workspace 流程。
WorkflowDataSourceType	列舉代表工作流程資料來源的類型。
WrapStyle	這個列舉會設定資料欄內內容的換行樣式。

Action

方法

方法	傳回類型	簡短說明
addRequiredWidget(requiredWidget)	Action	新增這項動作需要的的小工具名稱，以利有效提交。
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	指出這項動作是否需要所有小工具的輸入內容。
setFunctionName(functionName)	Action	設定要呼叫的回呼函式名稱。
setInteraction(interaction)	Action	設定與使用者的互動，只有在開啟對話方塊時才需要。
setLoadIndicator(loadIndicator)	Action	設定動作進行時顯示的載入指標。
setParameters(parameters)	Action	允許將自訂參數傳遞至回呼函式。
setPersistValues(persistValues)	Action	指出表單值是由用戶端值還是伺服器值決定 (在動作回應更新表單的 Card 後)。

ActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

ActionResponseBuilder

方法

方法	傳回類型	簡短說明
build()	ActionResponse	建構並驗證目前動作的回應。
setNavigation(navigation)	ActionResponseBuilder	設定對 Navigation 動作的回應。
setNotification(notification)	ActionResponseBuilder	設定動作啟動時顯示的通知。
setOpenLink(openLink)	ActionResponseBuilder	設定啟用動作時要前往的網址。
setStateChanged(stateChanged)	ActionResponseBuilder	設定旗標，指出這項動作變更了現有資料狀態。

ActionStatus

方法

方法	傳回類型	簡短說明
setStatusCode(statusCode)	ActionStatus	代表開啟或提交對話方塊要求的狀態。
setUserFacingMessage(message)	ActionStatus	要傳送給使用者的訊息，說明要求狀態。

Attachment

方法

方法	傳回類型	簡短說明
setIconUrl(iconUrl)	Attachment	設定附件的圖示網址。
setMimeType(mimeType)	Attachment	設定附件的 MIME 類型。
setResourceUrl(resourceUrl)	Attachment	設定附件的資源網址。
setTitle(title)	Attachment	設定附件的標題。

AuthorizationAction

方法

方法	傳回類型	簡短說明
setAuthorizationUrl(authorizationUrl)	AuthorizationAction	設定授權提示中顯示的授權網址，使用者會前往該網址。

AuthorizationException

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。
setAuthorizationUrl(authUrl)	AuthorizationException	設定授權提示中顯示的授權網址，使用者會前往該網址。
setCustomUiCallback(callback)	AuthorizationException	要呼叫的函式名稱，用於產生自訂授權提示。
setResourceDisplayName(name)	AuthorizationException	設定要求授權時向使用者顯示的名稱。
throwException()	void	觸發擲回這個例外狀況。

BorderStyle

方法

方法	傳回類型	簡短說明
setCornerRadius(radius)	BorderStyle	設定邊框的圓角半徑，例如 8。
setStrokeColor(color)	BorderStyle	設定邊框顏色。
setType(type)	BorderStyle	設定邊框類型。

BorderType

屬性

屬性	類型	說明
NO_BORDER	Enum	無框線樣式。
STROKE	Enum	筆劃邊框樣式。

Button

方法

方法	傳回類型	簡短說明
setAuthorizationAction(action)	Button	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	Button	設定動作，在點選物件時撰寫電子郵件草稿。
setOnClickAction(action)	Button	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	Button	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	Button	設定點選物件時要開啟的網址。
setOverflowMenu(menu)	Button	設定在點選物件時開啟的彈出式選單。

ButtonSet

方法

方法	傳回類型	簡短說明
addButton(button)	ButtonSet	新增按鈕。

CalendarEventActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

CalendarEventActionResponseBuilder

方法

方法	傳回類型	簡短說明
addAttachments(attachments)	CalendarEventActionResponseBuilder	指定在執行相關聯的 UI 動作時，回應應將附件新增至日曆活動。
addAttendees(emails)	CalendarEventActionResponseBuilder	指定在執行相關聯的 UI 動作時，回覆應將指定出席者新增至日曆活動。
build()	CalendarEventActionResponse	建構並驗證目前的日曆活動動作回應。
setConferenceData(conferenceData)	CalendarEventActionResponseBuilder	指定在執行相關聯的 UI 動作時，回應應將指定的會議資料設為日曆活動。

Card

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

CardAction

方法

方法	傳回類型	簡短說明
setAuthorizationAction(action)	CardAction	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	CardAction	設定動作，在點選物件時撰寫電子郵件草稿。
setOnClickAction(action)	CardAction	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	CardAction	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	CardAction	設定點選物件時要開啟的網址。
setText(text)	CardAction	設定這項動作的選單文字。

CardBuilder

方法

方法	傳回類型	簡短說明
addCardAction(cardAction)	CardBuilder	將 CardAction 新增至這張資訊卡。
addSection(section)	CardBuilder	為這張資訊卡新增區段。
build()	Card	建構並驗證目前的卡片。
setDisplayStyle(displayStyle)	CardBuilder	設定這張資訊卡的顯示樣式。
setFixedFooter(fixedFooter)	CardBuilder	為這張資訊卡設定固定頁尾。
setHeader(cardHeader)	CardBuilder	設定這張資訊卡的標題。
setName(name)	CardBuilder	設定這張卡片的名稱。
setPeekCardHeader(peekCardHeader)	CardBuilder	設定顯示卡片標頭。

CardHeader

方法

方法	傳回類型	簡短說明
setImageAltText(imageAltText)	CardHeader	設定標題圖片的替代文字。
setImageStyle(imageStyle)	CardHeader	設定資訊卡標題中的圖示裁剪方式。
setImageUrl(imageUrl)	CardHeader	提供圖片網址或資料字串，設定要在標題中使用的圖片。
setSubtitle(subtitle)	CardHeader	設定資訊卡標題的副標題。
setTitle(title)	CardHeader	設定資訊卡標題。

CardSection

方法

方法	傳回類型	簡短說明
addWidget(widget)	CardSection	將指定的小工具新增至這個部分。
setCollapseControl(collapseControl)	CardSection	設定可自訂的區段展開和收合按鈕。
setCollapsible(collapsible)	CardSection	設定是否可收合區段。
setHeader(header)	CardSection	設定區段的標題。
setNumUncollapsibleWidgets(numUncollapsibleWidgets)	CardSection	設定這個部分收合時仍會顯示的小工具數量。

CardService

屬性

屬性	類型	說明
BorderType	BorderType	BorderType 列舉。
ChipListLayout	ChipListLayout	ChipListLayout 列舉。
ComposedEmailType	ComposedEmailType	ComposedEmailType 列舉。
ContentType	ContentType	ContentType 列舉。
ExpressionDataActionType	ExpressionDataActionType	ExpressionDataActionType 列舉。
ExpressionDataConditionType	ExpressionDataConditionType	ExpressionDataConditionType 列舉。
GridItemLayout	GridItemLayout	GridItemLayout 列舉。
HorizontalAlignment	HorizontalAlignment	HorizontalAlignment 列舉。
Icon	Icon	Icon 列舉。
ImageButtonStyle	ImageButtonStyle	ImageButtonStyle 列舉。
ImageCropType	ImageCropType	ImageCropType 列舉。
ImageStyle	ImageStyle	ImageStyle 列舉。
InputType	InputType	InputType 列舉。
LoadIndicator	LoadIndicator	LoadIndicator 列舉。
OnClose	OnClose	OnClose 列舉。
OpenAs	OpenAs	OpenAs 列舉。
SelectionInputType	SelectionInputType	SelectionInputType 列舉。
TextButtonStyle	TextButtonStyle	TextButtonStyle 列舉。
UpdateDraftBodyType	UpdateDraftBodyType	UpdateDraftBodyType 列舉。
Visibility	Visibility	Visibility 列舉。
WorkflowDataSourceType	WorkflowDataSourceType	WorkflowDataSourceType 列舉。

方法

方法	傳回類型	簡短說明
newAction()	Action	建立新的 Action。
newActionResponseBuilder()	ActionResponseBuilder	建立新的 ActionResponseBuilder。
newActionStatus()	ActionStatus	建立新的 ActionStatus。
newAttachment()	Attachment	建立新的 Attachment。
newAuthorizationAction()	AuthorizationAction	建立新的 AuthorizationAction。
newAuthorizationException()	AuthorizationException	建立新的 AuthorizationException。
newBorderStyle()	BorderStyle	建立新的 BorderStyle。
newButtonSet()	ButtonSet	建立新的 ButtonSet。
newCalendarEventActionResponseBuilder()	CalendarEventActionResponseBuilder	建立新的 CalendarEventActionResponseBuilder。
newCardAction()	CardAction	建立新的 CardAction。
newCardBuilder()	CardBuilder	建立新的 Card 建構工具。
newCardHeader()	CardHeader	建立新的 CardHeader。
newCardSection()	CardSection	建立新的 CardSection。
newCardWithId()	CardWithId	建立新的 CardWithId。
newCarousel()	Carousel	建立 Carousel。
newCarouselCard()	CarouselCard	建立新的 CarouselCard。
newChatActionResponse()	ChatActionResponse	建立新的 ChatActionResponse。
newChatResponseBuilder()	ChatResponseBuilder	建立新的 ChatResponseBuilder。
newChip()	Chip	建立新的 Chip。
newChipList()	ChipList	建立新的 ChipList。
newCollapseControl()	CollapseControl	建立新的 CollapseControl。
newColumn()	Column	建立新的 Column。
newColumns()	Columns	建立新的 Columns 集。
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	建立新的 ComposeActionResponseBuilder。
newDatePicker()	DatePicker	建立新的 DatePicker。
newDateTimePicker()	DateTimePicker	建立新的 DateTimePicker。
newDecoratedText()	DecoratedText	建立新的 DecoratedText。
newDialog()	Dialog	建立新的 Dialog。
newDialogAction()	DialogAction	建立新的 DialogAction。
newDivider()	Divider	建立新的 Divider。
newDriveItemsSelectedActionResponseBuilder()	DriveItemsSelectedActionResponseBuilder	建立新的 DriveItemsSelectedActionResponseBuilder。
newEditorFileScopeActionResponseBuilder()	EditorFileScopeActionResponseBuilder	建立新的 EditorFileScopeActionResponseBuilder。
newFixedFooter()	FixedFooter	建立新的 FixedFooter。
newGrid()	Grid	建立新的 Grid。
newGridItem()	GridItem	建立新的 GridItem。
newHostAppDataSource()	HostAppDataSource	建立新的 HostAppDataSource，並傳回空白的 HostAppDataSource。
newIconImage()	IconImage	建立新的 IconImage。
newImage()	Image	建立新的 Image。
newImageButton()	ImageButton	建立新的 ImageButton。
newImageComponent()	ImageComponent	建立新的 ImageComponent。
newImageCropStyle()	ImageCropStyle	建立新的 ImageCropStyle。
newKeyValue()	KeyValue	建立新的 KeyValue。
newLinkPreview()	LinkPreview	建立新的 LinkPreview。
newMaterialIcon()	MaterialIcon	建立新的 MaterialIcon。
newNavigation()	Navigation	建立新的 Navigation。
newNotification()	Notification	建立新的 Notification。
newOpenLink()	OpenLink	建立新的 OpenLink。
newOverflowMenu()	OverflowMenu	建立新的 OverflowMenu。
newOverflowMenuItem()	OverflowMenuItem	建立新的 OverflowMenuItem。
newSelectionInput()	SelectionInput	建立新的 SelectionInput。
newSuggestions()	Suggestions	建立新的 Suggestions。
newSuggestionsResponseBuilder()	SuggestionsResponseBuilder	建立新的 SuggestionsResponseBuilder。
newSwitch()	Switch	建立新的 Switch。
newTextButton()	TextButton	建立新的 TextButton。
newTextInput()	TextInput	建立新的 TextInput。
newTextParagraph()	TextParagraph	建立新的 TextParagraph。
newTimePicker()	TimePicker	建立新的 TimePicker。
newUniversalActionResponseBuilder()	UniversalActionResponseBuilder	建立新的 UniversalActionResponseBuilder。
newUpdateDraftActionResponseBuilder()	UpdateDraftActionResponseBuilder	建立新的 UpdateDraftActionResponseBuilder。
newUpdateDraftBccRecipientsAction()	UpdateDraftBccRecipientsAction	建立新的 UpdateDraftBccRecipientsAction；
newUpdateDraftBodyAction()	UpdateDraftBodyAction	建立新的 UpdateDraftBodyAction。
newUpdateDraftCcRecipientsAction()	UpdateDraftCcRecipientsAction	建立新的 UpdateDraftCcRecipientsAction。
newUpdateDraftSubjectAction()	UpdateDraftSubjectAction	建立新的 UpdateDraftSubjectAction。
newUpdateDraftToRecipientsAction()	UpdateDraftToRecipientsAction	建立新的 UpdateDraftToRecipientsAction。
newValidation()	Validation	建立新的 Validation。

CardWithId

方法

方法	傳回類型	簡短說明
setCard(card)	CardWithId	設定 cardWithId 的卡片。
setCardId(id)	CardWithId	設定 cardWithId 的專屬卡片 ID。

Carousel

方法

方法	傳回類型	簡短說明
addCarouselCard(card)	Carousel	新增輪轉介面卡片。

CarouselCard

方法

方法	傳回類型	簡短說明
addFooterWidget(widget)	CarouselCard	將指定小工具新增至這個輪轉介面資訊卡的頁尾。
addWidget(widget)	CarouselCard	將指定的小工具新增至這個輪轉介面資訊卡。

ChatActionResponse

方法

方法	傳回類型	簡短說明
setDialogAction(dialogAction)	ChatActionResponse	將對話方塊動作設為與對話方塊相關的事件。
setResponseType(responseType)	ChatActionResponse	Chat 應用程式的回應類型。
setUpdatedWidget(updatedWidget)	ChatActionResponse	設定更新後的小工具，用於提供小工具的自動完成選項。
setUrl(url)	ChatActionResponse	使用者驗證或設定的網址。

ChatClientDataSource

方法

方法	傳回類型	簡短說明
setSpaceDataSource(spaceDataSource)	ChatClientDataSource	資料來源，可做為多選選單的選項，填入 Google Chat 聊天室。

ChatResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

ChatResponseBuilder

方法

方法	傳回類型	簡短說明
addCardsV2(cardWithId)	ChatResponseBuilder	設定訊息的資訊卡欄位。
build()	ChatResponse	建構並驗證目前動作的回應。
setActionResponse(actionResponse)	ChatResponseBuilder	設定訊息的動作回應欄位。
setText(text)	ChatResponseBuilder	設定 Chat 訊息的文字。

ChatSpaceDataSource

方法

方法	傳回類型	簡短說明
setDefaultToCurrentSpace(defaultToCurrentSpace)	ChatSpaceDataSource	如果設為 true，多重選取選單預設會選取目前的 Google Chat 聊天室做為項目。

Chip

方法

方法	傳回類型	簡短說明
setAltText(altText)	Chip	設定晶片的替代文字，方便使用者存取。
setAuthorizationAction(action)	Chip	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	Chip	設定動作，在點選物件時撰寫電子郵件草稿。
setDisabled(disabled)	Chip	設定是否停用晶片。
setIcon(icon)	Chip	設定要當做晶片的圖示。
setLabel(label)	Chip	設定晶片的標題。
setOnClickAction(action)	Chip	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	Chip	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	Chip	設定點選物件時要開啟的網址。

ChipList

方法

方法	傳回類型	簡短說明
addChip(chip)	ChipList	新增方塊。
setLayout(layout)	ChipList	設定晶片清單版面配置。

ChipListLayout

屬性

屬性	類型	說明
WRAPPED	Enum	如果水平空間不足，晶片清單會換行。
HORIZONTAL_SCROLLABLE	Enum	如果晶片無法放入可用空間，就會以水平方向捲動。

CollapseControl

方法

方法	傳回類型	簡短說明
setCollapseButton(button)	CollapseControl	設定「顯示較少」按鈕顯示的 Button。
setExpandButton(button)	CollapseControl	設定「顯示更多」按鈕顯示的 Button。
setHorizontalAlign(horizontalAlignment)	CollapseControl	設定 CollapseControl 的 HorizontalAlignment。

Column

方法

方法	傳回類型	簡短說明
addWidget(widget)	Column	在資料欄中新增小工具。
setHorizontalAlignment(horizontalAlignment)	Column	設定 Column 的 HorizontalAlignment。
setHorizontalSizeStyle(horizontalSizeStyle)	Column	設定資料欄的 HorizontalSizeStyle。
setVerticalAlignment(verticalAlignment)	Column	設定 Column 的 VerticalAlignment。

Columns

方法

方法	傳回類型	簡短說明
addColumn(column)	Columns	在「Columns」小工具中新增 Column。
setWrapStyle(wrapStyle)	Columns	設定欄的換行樣式，控制欄如何根據畫面寬度調整大小。

CommonDataSource

屬性

屬性	類型	說明
UNKNOWN	Enum	預設值。
USER	Enum	Google Workspace 使用者。

CommonWidgetAction

方法

方法	傳回類型	簡短說明
setUpdateVisibilityAction(updateVisibilityAction)	CommonWidgetAction	設定小工具的更新瀏覽權限動作。

ComposeActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

ComposeActionResponseBuilder

方法

方法	傳回類型	簡短說明
build()	ComposeActionResponse	建構目前的撰寫動作回應並驗證。
setGmailDraft(draft)	ComposeActionResponseBuilder	設定使用 GmailMessage.createDraftReply(body) 或類似函式建立的草稿 GmailMessage。

ComposedEmailType

屬性

屬性	類型	說明
REPLY_AS_DRAFT	Enum	回覆其他訊息的草稿。
STANDALONE_DRAFT	Enum	獨立郵件的草稿。

Condition

方法

方法	傳回類型	簡短說明
setActionRuleId(actionRuleId)	Condition	要根據條件執行的動作規則專屬 ID。
setExpressionDataCondition(expressionDataCondition)	Condition	設定 CEL 運算式驗證條件，判斷是否應執行事件動作。

ContentType

屬性

屬性	類型	說明
TEXT	Enum	表示生成的內容為純文字。
MUTABLE_HTML	Enum	指出生成的內容格式為 HTML。
IMMUTABLE_HTML	Enum	表示生成的內容格式為 HTML，但生成後無法編輯。

DatePicker

方法

方法	傳回類型	簡短說明
setFieldName(fieldName)	DatePicker	設定欄位名稱，在發生 UI 互動時產生的事件物件中，識別這個挑選器。
setOnChangeAction(action)	DatePicker	設定指令碼，在每次選擇器輸入內容變更時執行。Action
setTitle(title)	DatePicker	設定顯示在輸入欄位上方的標題。
setValueInMsSinceEpoch(valueMsEpoch)	DatePicker	設定要在輸入欄位中設定的預填值。
setValueInMsSinceEpoch(valueMsEpoch)	DatePicker	設定要在輸入欄位中設定的預填值。

DateTimePicker

方法

方法	傳回類型	簡短說明
setFieldName(fieldName)	DateTimePicker	設定欄位名稱，在發生 UI 互動時產生的事件物件中，識別這個挑選器。
setHostAppDataSource(hostAppDataSource)	DateTimePicker	在 Google Workspace 流程中，輸入變數可接受流程中其他步驟的日期時間輸出內容。
setOnChangeAction(action)	DateTimePicker	設定指令碼，在每次選擇器輸入內容變更時執行。Action
setTimeZoneOffsetInMins(timeZoneOffsetMins)	DateTimePicker	設定時區與世界標準時間的時差 (以分鐘為單位)。
setTitle(title)	DateTimePicker	設定顯示在輸入欄位上方的標題。
setValueInMsSinceEpoch(valueMsEpoch)	DateTimePicker	設定要在輸入欄位中設定的預填值。
setValueInMsSinceEpoch(valueMsEpoch)	DateTimePicker	設定要在輸入欄位中設定的預填值。

DecoratedText

方法

方法	傳回類型	簡短說明
setAuthorizationAction(action)	DecoratedText	設定授權動作，在點選物件時開啟授權流程的網址。
setBottomLabel(text)	DecoratedText	設定要當做鍵使用的標籤文字，並顯示在文字內容下方。
setButton(button)	DecoratedText	設定顯示在文字右側的 Button。
setComposeAction(action, composedEmailType)	DecoratedText	設定動作，在點選物件時撰寫電子郵件草稿。
setEndIcon(endIcon)	DecoratedText	設定顯示在內容右側的選用 IconImage。
setOnClickAction(action)	DecoratedText	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	DecoratedText	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	DecoratedText	設定點選物件時要開啟的網址。
setStartIcon(startIcon)	DecoratedText	設定要在文字內容前顯示的選用 IconImage。
setSwitchControl(switchToSet)	DecoratedText	設定顯示在內容右側的 Switch。
setText(text)	DecoratedText	設定要用做值的文字。
setTopLabel(text)	DecoratedText	設定要用做鍵的標籤文字，並顯示在文字內容上方。
setWrapText(wrapText)	DecoratedText	設定值文字應顯示在一行或多行。

Dialog

方法

方法	傳回類型	簡短說明
setBody(card)	Dialog	設定 Dialog 的卡片。

DialogAction

方法

方法	傳回類型	簡短說明
setActionStatus(actionStatus)	DialogAction	設定 DialogAction 的動作狀態。
setDialog(dialog)	DialogAction	設定 DialogAction 的對話方塊。

DisplayStyle

屬性

屬性	類型	說明
PEEK	Enum	在現有內容上方的外掛程式內容底部顯示資訊卡標題。
REPLACE	Enum	顯示卡片並取代現有內容。

Divider

DriveItemsSelectedActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

DriveItemsSelectedActionResponseBuilder

方法

方法	傳回類型	簡短說明
build()	DriveItemsSelectedActionResponse	建構目前的 Google 雲端硬碟動作回應。
requestFileScope(itemId)	DriveItemsSelectedActionResponseBuilder	指定回應要求雲端硬碟中與情境相關項目的檔案範圍。

EditorFileScopeActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

EditorFileScopeActionResponseBuilder

方法

方法	傳回類型	簡短說明
build()	EditorFileScopeActionResponse	建構目前的編輯器動作回應。
requestFileScopeForActiveDocument()	EditorFileScopeActionResponseBuilder	要求目前使用中編輯器文件的 drive.file 範圍。

EventAction

方法

方法	傳回類型	簡短說明
addPostEventTrigger(trigger)	EventAction	在事件動作執行後，新增 CEL 運算式驗證條件以進行評估。
setActionRuleId(actionRuleId)	EventAction	設定事件動作的專屬 ID。
setCommonWidgetAction(commonWidgetAction)	EventAction	設定小工具的常見小工具動作。
setExpressionDataAction(expressionDataAction)	EventAction	為小工具設定 CEL 運算式驗證資料動作。

ExpressionData

方法

方法	傳回類型	簡短說明
addCondition(condition)	ExpressionData	將條件新增至目前的運算式資料。
addEventAction(eventAction)	ExpressionData	將事件動作新增至目前的運算式資料。
setExpression(expression)	ExpressionData	設定運算式資料值。
setId(id)	ExpressionData	設定運算式資料 ID。

ExpressionDataAction

方法

方法	傳回類型	簡短說明
setActionType(type)	ExpressionDataAction	設定運算式資料動作的類型。

ExpressionDataActionType

屬性

屬性	類型	說明
ACTION_TYPE_UNSPECIFIED	Enum	未指定的動作類型。
START_EXPRESSION_EVALUATION	Enum	啟動 CEL 運算式驗證的動作。

ExpressionDataCondition

方法

方法	傳回類型	簡短說明
setConditionType(type)	ExpressionDataCondition	設定 CEL 運算式驗證的條件類型，指出運算式是否評估成功。

ExpressionDataConditionType

屬性

屬性	類型	說明
CONDITION_TYPE_UNSPECIFIED	Enum	未指定的條件類型。
EXPRESSION_EVALUATION_SUCCESS	Enum	CEL 運算式評估結果為成功。
EXPRESSION_EVALUATION_FAILURE	Enum	CEL 運算式評估結果為失敗。

FixedFooter

方法

方法	傳回類型	簡短說明
setPrimaryButton(button)	FixedFooter	在固定頁尾中設定主要按鈕。
setSecondaryButton(button)	FixedFooter	在固定頁尾中設定次要按鈕。

Grid

方法

方法	傳回類型	簡短說明
addItem(gridItem)	Grid	在格線中新增格線項目。
setAuthorizationAction(action)	Grid	設定授權動作，在點選物件時開啟授權流程的網址。
setBorderStyle(borderStyle)	Grid	設定套用至每個格線項目的邊框樣式。
setComposeAction(action, composedEmailType)	Grid	設定動作，在點選物件時撰寫電子郵件草稿。
setNumColumns(numColumns)	Grid	要在格線中顯示的欄數。
setOnClickAction(action)	Grid	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	Grid	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	Grid	設定點選物件時要開啟的網址。
setTitle(title)	Grid	設定格線的標題文字。

GridItem

方法

方法	傳回類型	簡短說明
setIdentifier(id)	GridItem	設定格線項目的 ID。
setImage(image)	GridItem	設定這個格線項目的圖片。
setLayout(layout)	GridItem	設定格線項目的文字和圖片版面配置。
setSubtitle(subtitle)	GridItem	設定格狀項目的子標題。
setTextAlignment(alignment)	GridItem	設定格線項目的水平對齊方式。
setTitle(title)	GridItem	設定格線項目的標題文字。

GridItemLayout

屬性

屬性	類型	說明
TEXT_BELOW	Enum	標題和副標題會顯示在格狀項目圖片下方。
TEXT_ABOVE	Enum	標題和副標題會顯示在格線項目的圖片上方。

HorizontalAlignment

屬性

屬性	類型	說明
START	Enum	將小工具對齊句子開頭。
CENTER	Enum	將小工具置中對齊。
END	Enum	將小工具對齊句子結尾。

HorizontalSizeStyle

屬性

屬性	類型	說明
FILL_AVAILABLE_SPACE	Enum	將 Widget 的大小設為填滿 Column 的可用水平空間。
FILL_MINIMUM_SPACE	Enum	調整 Widget 大小，盡量填滿 Column 中的水平空間。

HostAppDataSource

方法

方法	傳回類型	簡短說明
setChatDataSource(chatClientDataSource)	HostAppDataSource	設定 Google Chat 的資料來源。
setWorkflowDataSource(workflowDataSource)	HostAppDataSource	從 Google Workspace Flows 設定資料來源。

Icon

屬性

屬性	類型	說明
NONE	Enum	沒有圖示。
AIRPLANE	Enum
BOOKMARK	Enum
BUS	Enum
CAR	Enum
CLOCK	Enum
CONFIRMATION_NUMBER_ICON	Enum
DOLLAR	Enum
DESCRIPTION	Enum
EMAIL	Enum
EVENT_PERFORMER	Enum
EVENT_SEAT	Enum
FLIGHT_ARRIVAL	Enum
FLIGHT_DEPARTURE	Enum
HOTEL	Enum
HOTEL_ROOM_TYPE	Enum
INVITE	Enum
MAP_PIN	Enum
MEMBERSHIP	Enum
MULTIPLE_PEOPLE	Enum
OFFER	Enum
PERSON	Enum
PHONE	Enum
RESTAURANT_ICON	Enum
SHOPPING_CART	Enum
STAR	Enum
STORE	Enum
TICKET	Enum
TRAIN	Enum
VIDEO_CAMERA	Enum
VIDEO_PLAY	Enum

IconImage

方法

方法	傳回類型	簡短說明
setAltText(altText)	IconImage	設定用於無障礙功能的網址替代文字。
setIcon(icon)	IconImage	如果未設定網址，則設定預先定義的圖示。
setIconUrl(url)	IconImage	如果未設定圖示，則設定圖示的網址。
setImageCropType(imageCropType)	IconImage	設定圖片的裁剪樣式。
setMaterialIcon(icon)	IconImage	設定 Material Design 圖示。

Image

方法

方法	傳回類型	簡短說明
setAltText(altText)	Image	設定圖片的替代文字，方便使用者存取。
setAuthorizationAction(action)	Image	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	Image	設定動作，在點選物件時撰寫電子郵件草稿。
setImageUrl(url)	Image	提供圖片的網址或資料字串，即可設定要使用的圖片。
setOnClickAction(action)	Image	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	Image	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	Image	設定點選物件時要開啟的網址。

ImageButton

方法

方法	傳回類型	簡短說明
setAltText(altText)	ImageButton	設定按鈕的替代文字，方便使用者存取。
setAuthorizationAction(action)	ImageButton	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	ImageButton	設定動作，在點選物件時撰寫電子郵件草稿。
setIcon(icon)	ImageButton	設定要在按鈕上顯示的預先定義 Icon。
setIconUrl(url)	ImageButton	設定圖片網址，做為這個按鈕的圖示。
setImageButtonStyle(imageButtonStyle)	ImageButton	設定按鈕樣式。
setMaterialIcon(icon)	ImageButton	設定 Material Design 圖示。
setOnClickAction(action)	ImageButton	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	ImageButton	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	ImageButton	設定點選物件時要開啟的網址。
setOverflowMenu(menu)	ImageButton	設定在點選物件時開啟的彈出式選單。

ImageButtonStyle

屬性

屬性	類型	說明
BORDERLESS	Enum	沒有邊框的圖片按鈕。
OUTLINED	Enum	背景透明的圖片按鈕。
FILLED	Enum	背景為彩色的圖片按鈕。
FILLED_TONAL	Enum	圖片按鈕，介於實心和外框按鈕之間。

ImageComponent

方法

方法	傳回類型	簡短說明
setAltText(altText)	ImageComponent	設定圖片的替代文字。
setBorderStyle(borderStyle)	ImageComponent	設定套用至圖片的邊框樣式。
setCropStyle(imageCropStyle)	ImageComponent	設定圖片的裁剪樣式。
setImageUrl(url)	ImageComponent	設定圖片的網址。

ImageCropStyle

方法

方法	傳回類型	簡短說明
setAspectRatio(ratio)	ImageCropStyle	如果裁剪類型為 RECTANGLE_CUSTOM，請設定要使用的顯示比例。
setImageCropType(type)	ImageCropStyle	設定圖片的裁剪類型。

ImageCropType

屬性

屬性	類型	說明
SQUARE	Enum	正方形裁剪樣式。
CIRCLE	Enum	裁剪成圓形。
RECTANGLE_CUSTOM	Enum	矩形裁剪樣式，可自訂比例。
RECTANGLE_4_3	Enum	以 4:3 比例裁剪成矩形。

ImageStyle

屬性

屬性	類型	說明
SQUARE	Enum	不裁剪。
CIRCLE	Enum	裁剪成圓形。

InputType

屬性

屬性	類型	說明
TEXT	Enum	接受一般文字。
INTEGER	Enum	接受整數。
FLOAT	Enum	接受浮點數。
EMAIL	Enum	接受電子郵件地址。

Interaction

屬性

屬性	類型	說明
INTERACTION_UNSPECIFIED	Enum	預設值。
OPEN_DIALOG	Enum	開啟對話方塊，這是 Chat 應用程式用來與使用者互動的介面，以資訊卡為基礎。

KeyValue

方法

方法	傳回類型	簡短說明
setAuthorizationAction(action)	KeyValue	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	KeyValue	設定動作，在點選物件時撰寫電子郵件草稿。
setOnClickAction(action)	KeyValue	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	KeyValue	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	KeyValue	設定點選物件時要開啟的網址。

LinkPreview

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。
setLinkPreviewTitle(title)	LinkPreview	設定連結預覽畫面中，預覽資訊卡上方顯示的標題。
setPreviewCard(previewCard)	LinkPreview	設定顯示第三方或非 Google 服務連結相關資訊的資訊卡。
setTitle(title)	LinkPreview	設定連結預覽智慧型方塊中顯示的標題。

LoadIndicator

屬性

屬性	類型	說明
SPINNER	Enum	使用旋轉指標。
NONE	Enum	請勿使用指標。

MaterialIcon

方法

方法	傳回類型	簡短說明
setFill(fill)	MaterialIcon	圖示是否會填滿。
setGrade(grade)	MaterialIcon	符號的粗細會受到權重和等級影響。
setName(name)	MaterialIcon	設定圖示名稱。
setWeight(weight)	MaterialIcon	圖示的筆觸粗細。

Navigation

方法

方法	傳回類型	簡短說明
popCard()	Navigation	從導覽堆疊中彈出資訊卡。
popToNamedCard(cardName)	Navigation	根據資訊卡名稱彈出至指定資訊卡。
popToRoot()	Navigation	將卡片堆疊彈出至根卡片。
printJson()	String	列印這個物件的 JSON 表示法。
pushCard(card)	Navigation	將指定卡片推送到堆疊。
updateCard(card)	Navigation	就地更換目前的卡片。

Notification

方法

方法	傳回類型	簡短說明
setText(text)	Notification	設定要在通知中顯示的文字。

OnClose

屬性

屬性	類型	說明
NOTHING	Enum	關閉時不執行任何動作。
RELOAD	Enum	視窗關閉時重新載入外掛程式。

OpenAs

屬性

屬性	類型	說明
FULL_SIZE	Enum	以全視窗或分頁開啟。
OVERLAY	Enum	以疊加視窗 (例如彈出式視窗) 開啟。

OpenLink

方法

方法	傳回類型	簡短說明
setOnClose(onClose)	OpenLink	設定關閉網址視窗或分頁時的網址動作行為。
setOpenAs(openAs)	OpenLink	設定網址開啟時的行為。
setUrl(url)	OpenLink	設定要開啟的網址。

OverflowMenu

方法

方法	傳回類型	簡短說明
addMenuItem(menuItem)	OverflowMenu	新增選單項目。

OverflowMenuItem

方法

方法	傳回類型	簡短說明
setAuthorizationAction(action)	OverflowMenuItem	設定授權動作，在點選物件時開啟授權流程的網址。
setComposeAction(action, composedEmailType)	OverflowMenuItem	設定動作，在點選物件時撰寫電子郵件草稿。
setDisabled(disabled)	OverflowMenuItem	設定選單項目是否已停用。
setOnClickAction(action)	OverflowMenuItem	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	OverflowMenuItem	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	OverflowMenuItem	設定點選物件時要開啟的網址。
setStartIcon(icon)	OverflowMenuItem	設定選單項目的前置圖示。
setText(text)	OverflowMenuItem	設定選單項目的標題。

PlatformDataSource

方法

方法	傳回類型	簡短說明
setCommonDataSource(commonDataSource)	PlatformDataSource	設定 Google Workspace 的資料來源。
setHostAppDataSource(hostAppDataSource)	PlatformDataSource	用於在多選選單中填入空格。

ResponseType

屬性

屬性	類型	說明
TYPE_UNSPECIFIED	Enum	預設類型，會以 NEW_MESSAGE 處理。
NEW_MESSAGE	Enum	以新訊息的形式發布到主題。
UPDATE_MESSAGE	Enum	更新 Chat 應用程式的訊息。
UPDATE_USER_MESSAGE_CARDS	Enum	更新使用者訊息中的資訊卡。
REQUEST_CONFIG	Enum	私下要求使用者進行額外驗證或設定。
DIALOG	Enum	顯示對話方塊。
UPDATE_WIDGET	Enum	查詢小工具文字自動完成選項。

SelectionInput

方法

方法	傳回類型	簡短說明
addItem(text, value, selected)	SelectionInput	新增可選取的新項目。
addMultiSelectItem(text, value, selected, startIconUri, bottomText)	SelectionInput	為多選選單新增可選取的項目。
setExternalDataSource(action)	SelectionInput	設定外部資料來源，例如關聯式資料庫。
setFieldName(fieldName)	SelectionInput	設定在發生 UI 互動時產生的事件物件中，用於識別這個選取輸入內容的鍵。
setMultiSelectMaxSelectedItems(maxSelectedItems)	SelectionInput	設定使用者可選取的項目數量上限。
setMultiSelectMinQueryLength(queryLength)	SelectionInput	設定使用者輸入多少個文字字元後，應用程式才會查詢自動完成功能，並在資訊卡上顯示建議項目。
setOnChangeAction(action)	SelectionInput	設定在選取輸入內容變更時執行的 Action。
setPlatformDataSource(platformDataSource)	SelectionInput	設定 Google Workspace 的資料來源。
setTitle(title)	SelectionInput	設定顯示在輸入欄位前的標題。
setType(type)	SelectionInput	設定這個輸入內容的類型。

SelectionInputType

屬性

屬性	類型	說明
CHECK_BOX	Enum	核取方塊輸入樣式。
RADIO_BUTTON	Enum	圓形按鈕輸入樣式。
DROPDOWN	Enum	下拉式選單選取輸入樣式。
SWITCH	Enum	一組切換開關。
MULTI_SELECT	Enum	靜態或動態資料的多選選單。
OVERFLOW_MENU	Enum	UI 元素，用於容納不適合放在主要介面中的其他選項

Status

屬性

屬性	類型	說明
OK	Enum	HTTP 對應：200 OK
CANCELLED	Enum	HTTP 對應：499 用戶端已關閉要求
UNKNOWN	Enum	發生不明錯誤。
INVALID_ARGUMENT	Enum	用戶端指定了無效的引數。
DEADLINE_EXCEEDED	Enum	HTTP 對應：504 閘道逾時
NOT_FOUND	Enum	HTTP 對應：404 找不到
ALREADY_EXISTS	Enum	用戶端嘗試建立的實體已存在。
PERMISSION_DENIED	Enum	HTTP 對應：403 禁止
UNAUTHENTICATED	Enum	HTTP 對應：401 未授權
RESOURCE_EXHAUSTED	Enum	HTTP 對應：429 太多要求
FAILED_PRECONDITION	Enum	作業已遭拒絕，因為系統未處於執行該作業所需的狀態。
ABORTED	Enum	作業已取消，原因通常是排序器檢查失敗或交易取消等並行問題。
OUT_OF_RANGE	Enum	嘗試執行的作業超出有效範圍。
UNIMPLEMENTED	Enum	HTTP 對應：501 未實作
INTERNAL	Enum	內部錯誤。
UNAVAILABLE	Enum	HTTP 對應：503 服務不可用
DATA_LOSS	Enum	無法復原的資料遺失或損毀。

Suggestions

方法

方法	傳回類型	簡短說明
addSuggestion(suggestion)	Suggestions	新增文字建議。
addSuggestions(suggestions)	Suggestions	新增文字建議清單。

SuggestionsResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

SuggestionsResponseBuilder

方法

方法	傳回類型	簡短說明
build()	SuggestionsResponse	建構目前的建議回覆並驗證。
setSuggestions(suggestions)	SuggestionsResponseBuilder	設定文字欄位自動完成功能使用的建議。

Switch

方法

方法	傳回類型	簡短說明
setControlType(controlType)	Switch	設定切換按鈕的控制項類型。
setFieldName(fieldName)	Switch	設定在發生 UI 互動時產生的事件物件中，用於識別這個切換鈕的金鑰。
setOnChangeAction(action)	Switch	設定切換開關切換時要採取的動作。
setSelected(selected)	Switch	設定這個切換鈕的初始狀態為選取或未選取。
setValue(value)	Switch	設定在切換開關開啟時，要以表單輸入內容的形式傳送的值。

SwitchControlType

屬性

屬性	類型	說明
SWITCH	Enum	切換小工具的切換樣式控制項。
CHECK_BOX	Enum	切換小工具的核取方塊樣式控制項。

TextButton

方法

方法	傳回類型	簡短說明
setAltText(altText)	TextButton	設定按鈕的替代文字，方便使用者存取。
setAuthorizationAction(action)	TextButton	設定授權動作，在點選物件時開啟授權流程的網址。
setBackgroundColor(backgroundColor)	TextButton	設定 TextButtonStyle.FILLED 按鈕的背景顏色。
setComposeAction(action, composedEmailType)	TextButton	設定動作，在點選物件時撰寫電子郵件草稿。
setDisabled(disabled)	TextButton	設定按鈕是否停用。
setIcon(icon)	TextButton	設定要在按鈕上顯示的預先定義 Icon。
setIconUrl(url)	TextButton	設定圖片網址，做為這個按鈕的圖示。
setMaterialIcon(icon)	TextButton	設定 Material Design 圖示。
setOnClickAction(action)	TextButton	設定在點選物件時執行的動作。
setOnClickOpenLinkAction(action)	TextButton	設定動作，在點選物件時於分頁中開啟網址。
setOpenLink(openLink)	TextButton	設定點選物件時要開啟的網址。
setOverflowMenu(menu)	TextButton	設定在點選物件時開啟的彈出式選單。
setText(text)	TextButton	設定按鈕上顯示的文字。
setTextButtonStyle(textButtonStyle)	TextButton	設定按鈕樣式。

TextButtonStyle

屬性

屬性	類型	說明
OUTLINED	Enum	背景透明的一般文字按鈕。
TEXT	Enum	請勿使用。
FILLED	Enum	彩色背景上的文字按鈕。
FILLED_TONAL	Enum	介於實心和外框按鈕之間的替代中間地帶，是正常的文字按鈕。
BORDERLESS	Enum	沒有邊框的一般文字按鈕。

TextInput

方法

方法	傳回類型	簡短說明
setFieldName(fieldName)	TextInput	設定在發生 UI 互動時產生的事件物件中，用於識別這個文字輸入內容的鍵。
setHint(hint)	TextInput	設定文字輸入的提示。
setHostAppDataSource(hostAppDataSource)	TextInput	設定 Google Workspace 應用程式的資料來源。
setMultiline(multiline)	TextInput	設定輸入文字顯示在一行或多行。
setOnChangeAction(action)	TextInput	設定在文字輸入內容變更時執行的動作。
setSuggestions(suggestions)	TextInput	設定文字欄位的自動完成建議。
setSuggestionsAction(suggestionsAction)	TextInput	設定回呼動作，根據使用者輸入的自動完成內容擷取建議。
setTitle(title)	TextInput	設定要顯示在輸入欄位上方的標題。
setValidation(validation)	TextInput	為這個小工具設定驗證規則。
setValue(value)	TextInput	設定要在輸入欄位中設定的預填值。

TextParagraph

方法

方法	傳回類型	簡短說明
setMaxLines(maxLines)	TextParagraph	設定要在小工具中顯示的文字行數上限。
setText(text)	TextParagraph	設定段落文字。

TimePicker

方法

方法	傳回類型	簡短說明
setFieldName(fieldName)	TimePicker	設定欄位名稱，在發生 UI 互動時產生的事件物件中，識別這個挑選器。
setHours(hours)	TimePicker	設定要在輸入欄位中填入的預填時數值。
setMinutes(minutes)	TimePicker	設定要在輸入欄位中填入的預填分鐘值。
setOnChangeAction(action)	TimePicker	設定指令碼，在每次選擇器輸入內容變更時執行。Action
setTitle(title)	TimePicker	設定顯示在輸入欄位上方的標題。

Trigger

方法

方法	傳回類型	簡短說明
setActionRuleId(actionRuleId)	Trigger	設定觸發條件的動作規則 ID。

UniversalActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

UniversalActionResponseBuilder

方法

方法	傳回類型	簡短說明
build()	UniversalActionResponse	建構並驗證目前的通用動作回應。
displayAddOnCards(cardObjects)	UniversalActionResponseBuilder	顯示含有指定資訊卡的加購內容。
setOpenLink(openLink)	UniversalActionResponseBuilder	設定選取通用動作時要開啟的網址。

UpdateDraftActionResponse

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

UpdateDraftActionResponseBuilder

方法

方法	傳回類型	簡短說明
build()	UpdateDraftActionResponse	建構並驗證目前的更新草稿動作回應。
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)	UpdateDraftActionResponseBuilder	設定更新草稿電子郵件密件副本收件者的動作。
setUpdateDraftBodyAction(updateDraftBodyAction)	UpdateDraftActionResponseBuilder	設定可更新草稿電子郵件內文的動作。
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)	UpdateDraftActionResponseBuilder	設定可更新草稿副本收件者的動作。
setUpdateDraftSubjectAction(updateDraftSubjectAction)	UpdateDraftActionResponseBuilder	設定可更新草稿主旨行的動作。
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)	UpdateDraftActionResponseBuilder	設定更新草稿收件者的動作。

UpdateDraftBccRecipientsAction

方法

方法	傳回類型	簡短說明
addUpdateBccRecipients(bccRecipientEmails)	UpdateDraftBccRecipientsAction	更新電子郵件草稿的密件副本收件者。

UpdateDraftBodyAction

方法

方法	傳回類型	簡短說明
addUpdateContent(content, contentType)	UpdateDraftBodyAction	將指定內容新增至草稿主體。
setUpdateType(updateType)	UpdateDraftBodyAction	在草稿主體中設定這項更新動作的 UpdateDraftBodyType。

UpdateDraftBodyType

屬性

屬性	類型	說明
IN_PLACE_INSERT	Enum	預設值。
INSERT_AT_START	Enum	更新動作會在郵件內文開頭插入內容。
INSERT_AT_END	Enum	更新動作會在郵件內文結尾插入內容。

UpdateDraftCcRecipientsAction

方法

方法	傳回類型	簡短說明
addUpdateCcRecipients(ccRecipientEmails)	UpdateDraftCcRecipientsAction	更新電子郵件草稿的副本收件者。

UpdateDraftSubjectAction

方法

方法	傳回類型	簡短說明
addUpdateSubject(subject)	UpdateDraftSubjectAction	更新電子郵件草稿的主旨行。

UpdateDraftToRecipientsAction

方法

方法	傳回類型	簡短說明
addUpdateToRecipients(toRecipientEmails)	UpdateDraftToRecipientsAction	更新電子郵件草稿的收件者。

UpdateVisibilityAction

方法

方法	傳回類型	簡短說明
setVisibility(visibility)	UpdateVisibilityAction	將小工具設為顯示或隱藏。

UpdatedWidget

方法

方法	傳回類型	簡短說明
addItem(text, value, selected, startIconUri, bottomText)	UpdatedWidget	新增可選取的新項目。

Validation

方法

方法	傳回類型	簡短說明
setCharacterLimit(characterLimit)	Validation	設定小工具的字元限制。
setInputType(inputType)	Validation	設定小工具的輸入類型。

VariableButtonSize

屬性

屬性	類型	說明
UNSPECIFIED	Enum	自動選擇「側邊面板」COMPACT，否則選擇 FULL_SIZE。
COMPACT	Enum	標示為「+」的按鈕
FULL_SIZE	Enum	標示為「+ 變數」的按鈕

VerticalAlignment

屬性

屬性	類型	說明
CENTER	Enum	將內容垂直放置在容器中央。
TOP	Enum	將內容垂直放置在容器頂端。
BOTTOM	Enum	將內容垂直放置在容器底部。

Visibility

屬性

屬性	類型	說明
VISIBLE	Enum	顯示 UI 元素。
HIDDEN	Enum	UI 元素已隱藏。
VISIBILITY_UNSPECIFIED	Enum	未指定 UI 元素。

Widget

WorkflowDataSource

方法

方法	傳回類型	簡短說明
setIncludeVariables(includeVariables)	WorkflowDataSource	是否要在資料來源中加入上一步的變數。
setType(type)	WorkflowDataSource	設定工作流程資料來源的類型。
setVariableButtonLabel(variableButtonLabel)	WorkflowDataSource	設定變數挑選器按鈕的標籤，該標籤會顯示在 FULL_SIZE 按鈕大小的「+」符號後方。
setVariableButtonSize(variableButtonSize)	WorkflowDataSource	設定變數挑選器按鈕的大小。如果選取 UNSPECIFIED，Workflow 會自動在側邊面板中使用 COMPACT，在其他情況下使用 FULL_SIZE。

WorkflowDataSourceType

屬性

屬性	類型	說明
UNKNOWN	Enum	預設值。
USER	Enum	資料來源為使用者的資料。
SPACE	Enum	資料來源是 Google Chat 聊天室。
USER_WITH_FREE_FORM	Enum	資料來源為使用者資料；使用者可以選擇查看及選取 Google Workspace 機構中的現有成員，或手動輸入電子郵件地址或有效網域。

WrapStyle

屬性

屬性	類型	說明
NOWRAP	Enum	不換行。
WRAP	Enum	將資料欄中任何小工具的內容換行。