Card Service

卡片服務

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

類別

名稱簡短說明
Action可在 UI 元素中啟用互動功能的操作。
ActionResponse可從回呼函式 (例如表單回應處理常式) 傳回的回應物件,用於在用戶端執行一或多項動作。
ActionResponseBuilderActionResponse 物件的建構工具。
ActionStatus這個類別代表呼叫或提交對話方塊的要求狀態。
Attachment代表外掛程式建立的附件。
AuthorizationAction授權動作,使用者點選後會前往 AuthorizationUrl。
AuthorizationException可傳回的錯誤,用於觸發向使用者顯示授權卡。
BorderStyle代表可套用至小工具的完整邊框樣式類別。
BorderType列舉代表可套用至小工具的邊框類型。
Button所有按鈕的基礎類別。
ButtonSet保存一組以資料列形式顯示的 Button 物件。
CalendarEventActionResponse代表回應,可因應使用者在 UI 中執行的動作 (例如點選按鈕),變更使用者目前編輯的日曆活動。
CalendarEventActionResponseBuilderCalendarEventActionResponse 物件的建構工具。
Card代表 UI 中單一檢視畫面的內容資訊卡
CardAction可點選的選單項目,會新增至資訊卡標題選單。
CardBuilderCard 物件的建構工具。
CardHeaderCard 的標頭。
CardSection資訊卡區段會保留小工具群組,並在群組之間提供視覺化分隔。
CardServiceCardService 可建立通用卡片,用於各種 Google 擴充性產品,例如 Google Workspace 外掛程式
CardWithIdCardWithId 物件的建構工具。
Carousel輪播 (又稱滑桿) 會以投影片形式輪流顯示小工具清單,並提供按鈕,方便使用者前往上一個或下一個小工具。
CarouselCard可做為輪轉介面項目的資訊卡。
ChatActionResponse這個類別代表即時通訊應用程式可用來設定回應發布方式的參數。
ChatClientDataSource使用多重選取選單的 SelectionInput 小工具,以及 Google Chat 的資料來源。
ChatResponseGoogle Chat 中卡片訊息的回覆物件。
ChatResponseBuilderChatResponse 物件的建構工具。
ChatSpaceDataSource資料來源,可做為多選選單的選項,填入 Google Chat 聊天室。
Chip含有圖示和文字標籤的 Chip
ChipList包含一組 Chip 物件,這些物件會顯示在同一列中,並換行至下一行,以進行水平捲動。
ChipListLayout指定 ChipList 版面配置的列舉。
CollapseControl可自訂的收合和展開控制項。
Column資料欄。
ColumnsColumns 小工具最多可在資訊卡或對話方塊中顯示 2 欄。
CommonDataSource所有 Google Workspace 應用程式共用的資料來源。
CommonWidgetAction定義不涉及評估的動作,例如更新小工具顯示狀態。
ComposeActionResponse回呼方法可能會傳回的回應物件,適用於 Gmail 外掛程式中的撰寫動作。
ComposeActionResponseBuilderComposeActionResponse 物件的建構工具。
ComposedEmailType列舉值,用於指定撰寫的電子郵件是獨立郵件還是回覆草稿。
Condition用來執行事件動作的條件,是 CEL 運算式驗證的一部分。
ContentType列舉值,用於指定 UpdateDraftActionResponse 生成內容的內容類型。
DatePicker可輸入日期的輸入欄位。
DateTimePicker使用者可輸入日期和時間的輸入欄位。
DecoratedText顯示文字的小工具,可選擇是否要加上裝飾。
Dialog詳情請參閱 Google Chat 說明文件中的「開啟互動式對話方塊」。
DialogActionDialogAction 物件的建構工具。
DisplayStyle定義資訊卡顯示樣式的列舉。
Divider水平分隔線。
DriveItemsSelectedActionResponse代表在選取雲端硬碟項目時,因應 UI 中執行的動作 (例如點按按鈕) 而對雲端硬碟所做的變更。
DriveItemsSelectedActionResponseBuilderDriveItemsSelectedActionResponse 物件的建構工具。
EditorFileScopeActionResponse根據 UI 中執行的動作,變更編輯器 (例如 Google 文件、試算表或簡報)。
EditorFileScopeActionResponseBuilderEditorFileScopeActionResponse 物件的建構工具。
EventAction符合 CEL 運算式驗證條件時要執行的 EventAction。
ExpressionData用於評估運算式的運算式資料
ExpressionDataActionCEL 運算式驗證採取動作。
ExpressionDataActionType列舉代表運算式資料動作的類型。
ExpressionDataCondition代表 CEL 運算式驗證結果。
ExpressionDataConditionType代表 CEL 運算式是否成功評估。
FixedFooter顯示在 Card 底部的固定頁尾。
Grid有條不紊的格線,可顯示格線項目集合。
GridItem使用者在格線小工具中互動的項目。
GridItemLayout這個列舉會定義 GridItem 的圖片和文字樣式。
HorizontalAlignment列舉,指定小工具的水平對齊方式。
HorizontalSizeStyle這個列舉會設定小工具填滿資料欄空間的方式。
HostAppDataSource如果 SelectionInput 小工具使用多選選單,則資料來源必須是 Google Workspace 應用程式。
Icon預先定義的圖示,可用於各種 UI 物件,例如 ImageButtonDecoratedText 小工具。
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可從建議回呼函式傳回的回應物件。
SuggestionsResponseBuilderSuggestionsResponse 物件的建構工具。
Switch可開啟或關閉的 UI 元素。
SwitchControlTypeSwitch 小工具控制項的類型。
TextButton附有文字標籤的 TextButton
TextButtonStyle指定 TextButton 樣式的列舉。
TextInput可接受文字輸入的輸入欄位小工具。
TextParagraph顯示文字並支援基本 HTML 格式的小工具。
TimePicker使用者可透過這個輸入欄位輸入時間。
Trigger觸發條件:根據動作規則 ID 執行 CEL 表達式驗證小工具事件動作。
UniversalActionResponse方法可能會傳回的回應物件,用於建立通用動作。
UniversalActionResponseBuilderUniversalActionResponse 物件的建構工具。
UpdateDraftActionResponse代表更新使用者目前編輯的電子郵件草稿的動作。
UpdateDraftActionResponseBuilderUpdateDraftActionResponse 物件的建構工具。
UpdateDraftBccRecipientsAction更新電子郵件草稿的密件副本收件者。
UpdateDraftBodyAction更新電子郵件草稿內文。
UpdateDraftBodyType指定 UpdateDraftBodyAction 類型的列舉值。
UpdateDraftCcRecipientsAction更新電子郵件草稿的副本收件者。
UpdateDraftSubjectAction更新電子郵件草稿的主旨行。
UpdateDraftToRecipientsAction更新電子郵件草稿的收件者。
UpdateVisibilityAction更新資訊卡小工具的顯示設定,使其顯示或隱藏。
UpdatedWidget更新後的小工具回應。
Validation定義所附加小工具驗證規則的物件。
VariableButtonSize表示變數挑選器按鈕大小的列舉。
VerticalAlignment這個列舉會設定資料欄中小工具的垂直對齊方式。
Visibility列舉代表小工具的顯示狀態。
Widget可新增至 Card 的所有小工具的基礎類別。
WorkflowDataSource如果是 SelectionInputDateTimePickerTextInput 小工具,資料來源來自 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_BORDEREnum無框線樣式。
STROKEEnum筆劃邊框樣式。

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)CardBuilderCardAction 新增至這張資訊卡。
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

屬性

屬性類型說明
BorderTypeBorderTypeBorderType 列舉。
ChipListLayoutChipListLayoutChipListLayout 列舉。
ComposedEmailTypeComposedEmailTypeComposedEmailType 列舉。
ContentTypeContentTypeContentType 列舉。
ExpressionDataActionTypeExpressionDataActionTypeExpressionDataActionType 列舉。
ExpressionDataConditionTypeExpressionDataConditionTypeExpressionDataConditionType 列舉。
GridItemLayoutGridItemLayoutGridItemLayout 列舉。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 列舉。
IconIconIcon 列舉。
ImageButtonStyleImageButtonStyleImageButtonStyle 列舉。
ImageCropTypeImageCropTypeImageCropType 列舉。
ImageStyleImageStyleImageStyle 列舉。
InputTypeInputTypeInputType 列舉。
LoadIndicatorLoadIndicatorLoadIndicator 列舉。
OnCloseOnCloseOnClose 列舉。
OpenAsOpenAsOpenAs 列舉。
SelectionInputTypeSelectionInputTypeSelectionInputType 列舉。
TextButtonStyleTextButtonStyleTextButtonStyle 列舉。
UpdateDraftBodyTypeUpdateDraftBodyTypeUpdateDraftBodyType 列舉。
VisibilityVisibilityVisibility 列舉。
WorkflowDataSourceTypeWorkflowDataSourceTypeWorkflowDataSourceType 列舉。

方法

方法傳回類型簡短說明
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。

方法

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

CarouselCard

方法

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

ChatActionResponse

方法

方法傳回類型簡短說明
setDialogAction(dialogAction)ChatActionResponse將對話方塊動作設為與對話方塊相關的事件。
setResponseType(responseType)ChatActionResponseChat 應用程式的回應類型。
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

屬性

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

CollapseControl

方法

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

Column

Columns

方法

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

CommonDataSource

屬性

屬性類型說明
UNKNOWNEnum預設值。
USEREnumGoogle Workspace 使用者。

CommonWidgetAction

方法

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

ComposeActionResponse

方法

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

ComposeActionResponseBuilder

方法

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

ComposedEmailType

屬性

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

Condition

方法

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

ContentType

屬性

屬性類型說明
TEXTEnum表示生成的內容為純文字。
MUTABLE_HTMLEnum指出生成的內容格式為 HTML。
IMMUTABLE_HTMLEnum表示生成的內容格式為 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

屬性

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

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_UNSPECIFIEDEnum未指定的動作類型。
START_EXPRESSION_EVALUATIONEnum啟動 CEL 運算式驗證的動作。

ExpressionDataCondition

方法

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

ExpressionDataConditionType

屬性

屬性類型說明
CONDITION_TYPE_UNSPECIFIEDEnum未指定的條件類型。
EXPRESSION_EVALUATION_SUCCESSEnumCEL 運算式評估結果為成功。
EXPRESSION_EVALUATION_FAILUREEnumCEL 運算式評估結果為失敗。

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_BELOWEnum標題和副標題會顯示在格狀項目圖片下方。
TEXT_ABOVEEnum標題和副標題會顯示在格線項目的圖片上方。

HorizontalAlignment

屬性

屬性類型說明
STARTEnum將小工具對齊句子開頭。
CENTEREnum將小工具置中對齊。
ENDEnum將小工具對齊句子結尾。

HorizontalSizeStyle

屬性

屬性類型說明
FILL_AVAILABLE_SPACEEnumWidget 的大小設為填滿 Column 的可用水平空間。
FILL_MINIMUM_SPACEEnum調整 Widget 大小,盡量填滿 Column 中的水平空間。

HostAppDataSource

方法

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

Icon

屬性

屬性類型說明
NONEEnum沒有圖示。
AIRPLANEEnum飛機圖示
BOOKMARKEnum書籤圖示
BUSEnum公車圖示
CAREnum車輛圖示
CLOCKEnum時鐘圖示
CONFIRMATION_NUMBER_ICONEnum確認號碼圖示
DOLLAREnum美元圖示
DESCRIPTIONEnum說明圖示
EMAILEnum電子郵件圖示
EVENT_PERFORMEREnum電子郵件圖示
EVENT_SEATEnum活動座位圖示
FLIGHT_ARRIVALEnum航班抵達圖示
FLIGHT_DEPARTUREEnum航班起飛圖示
HOTELEnum飯店圖示
HOTEL_ROOM_TYPEEnum飯店圖示
INVITEEnum邀請圖示
MAP_PINEnum地圖圖釘圖示
MEMBERSHIPEnum會員方案圖示
MULTIPLE_PEOPLEEnum多人圖示
OFFEREnum方案圖示
PERSONEnum人形圖示
PHONEEnum「電話」圖示
RESTAURANT_ICONEnum餐廳圖示
SHOPPING_CARTEnum購物車圖示
STAREnum星號圖示
STOREEnum商店圖示
TICKETEnum票券圖示
TRAINEnum火車圖示
VIDEO_CAMERAEnum攝影機圖示
VIDEO_PLAYEnum影片播放圖示

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

屬性

屬性類型說明
BORDERLESSEnum沒有邊框的圖片按鈕。
OUTLINEDEnum背景透明的圖片按鈕。
FILLEDEnum背景為彩色的圖片按鈕。
FILLED_TONALEnum圖片按鈕,介於實心和外框按鈕之間。

ImageComponent

方法

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

ImageCropStyle

方法

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

ImageCropType

屬性

屬性類型說明
SQUAREEnum正方形裁剪樣式。
CIRCLEEnum裁剪成圓形。
RECTANGLE_CUSTOMEnum矩形裁剪樣式,可自訂比例。
RECTANGLE_4_3Enum以 4:3 比例裁剪成矩形。

ImageStyle

屬性

屬性類型說明
SQUAREEnum不裁剪。
CIRCLEEnum裁剪成圓形。

InputType

屬性

屬性類型說明
TEXTEnum接受一般文字。
INTEGEREnum接受整數。
FLOATEnum接受浮點數。
EMAILEnum接受電子郵件地址。

Interaction

屬性

屬性類型說明
INTERACTION_UNSPECIFIEDEnum預設值。
OPEN_DIALOGEnum開啟對話方塊,這是 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

屬性

屬性類型說明
SPINNEREnum使用旋轉指標。
NONEEnum請勿使用指標。

MaterialIcon

方法

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

方法

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

Notification

方法

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

OnClose

屬性

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

OpenAs

屬性

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

方法

方法傳回類型簡短說明
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_UNSPECIFIEDEnum預設類型,會以 NEW_MESSAGE 處理。
NEW_MESSAGEEnum以新訊息的形式發布到主題。
UPDATE_MESSAGEEnum更新 Chat 應用程式的訊息。
UPDATE_USER_MESSAGE_CARDSEnum更新使用者訊息中的資訊卡。
REQUEST_CONFIGEnum私下要求使用者進行額外驗證或設定。
DIALOGEnum顯示對話方塊。
UPDATE_WIDGETEnum查詢小工具文字自動完成選項。

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_BOXEnum核取方塊輸入樣式。
RADIO_BUTTONEnum圓形按鈕輸入樣式。
DROPDOWNEnum下拉式選單選取輸入樣式。
SWITCHEnum一組切換開關。
MULTI_SELECTEnum靜態或動態資料的多選選單。
OVERFLOW_MENUEnumUI 元素,用於容納不適合放在主要介面中的其他選項

Status

屬性

屬性類型說明
OKEnumHTTP 對應:200 OK
CANCELLEDEnumHTTP 對應:499 用戶端已關閉要求
UNKNOWNEnum發生不明錯誤。
INVALID_ARGUMENTEnum用戶端指定了無效的引數。
DEADLINE_EXCEEDEDEnumHTTP 對應:504 閘道逾時
NOT_FOUNDEnumHTTP 對應:404 找不到
ALREADY_EXISTSEnum用戶端嘗試建立的實體已存在。
PERMISSION_DENIEDEnumHTTP 對應:403 禁止
UNAUTHENTICATEDEnumHTTP 對應:401 未授權
RESOURCE_EXHAUSTEDEnumHTTP 對應:429 太多要求
FAILED_PRECONDITIONEnum作業已遭拒絕,因為系統未處於執行該作業所需的狀態。
ABORTEDEnum作業已取消,原因通常是排序器檢查失敗或交易取消等並行問題。
OUT_OF_RANGEEnum嘗試執行的作業超出有效範圍。
UNIMPLEMENTEDEnumHTTP 對應:501 未實作
INTERNALEnum內部錯誤。
UNAVAILABLEEnumHTTP 對應:503 服務不可用
DATA_LOSSEnum無法復原的資料遺失或損毀。

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

屬性

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

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

屬性

屬性類型說明
OUTLINEDEnum背景透明的一般文字按鈕。
TEXTEnum請勿使用。
FILLEDEnum彩色背景上的文字按鈕。
FILLED_TONALEnum介於實心和外框按鈕之間的替代中間地帶,是正常的文字按鈕。
BORDERLESSEnum沒有邊框的一般文字按鈕。

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_INSERTEnum預設值。
INSERT_AT_STARTEnum更新動作會在郵件內文開頭插入內容。
INSERT_AT_ENDEnum更新動作會在郵件內文結尾插入內容。

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

屬性

屬性類型說明
UNSPECIFIEDEnum自動選擇「側邊面板」COMPACT,否則選擇 FULL_SIZE
COMPACTEnum標示為「+」的按鈕
FULL_SIZEEnum標示為「+ 變數」的按鈕

VerticalAlignment

屬性

屬性類型說明
CENTEREnum將內容垂直放置在容器中央。
TOPEnum將內容垂直放置在容器頂端。
BOTTOMEnum將內容垂直放置在容器底部。

Visibility

屬性

屬性類型說明
VISIBLEEnum顯示 UI 元素。
HIDDENEnumUI 元素已隱藏。
VISIBILITY_UNSPECIFIEDEnum未指定 UI 元素。

Widget

WorkflowDataSource

方法

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

WorkflowDataSourceType

屬性

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

WrapStyle

屬性

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