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 物件的建構工具。
ChatActionResponse	這個類別代表 Chat 應用程式可使用的參數，設定回應的發布方式。
ChatClientDataSource	如果 SelectionInput 小工具使用複選選單，則為 Google Chat 的資料來源。
ChatResponse	Google Chat 中卡片訊息的回應物件。
ChatResponseBuilder	ChatResponse 物件的建構工具。
ChatSpaceDataSource	這個資料來源可將 Google Chat 聊天室填入複選選單的選取項目。
CommonDataSource	所有 Google Workspace 應用程式共用的資料來源。
ComposeActionResponse	您在 Gmail 外掛程式中撰寫動作的回呼方法可能傳回的回應物件。
ComposeActionResponseBuilder	ComposeActionResponse 物件的建構工具。
ComposedEmailType	列舉值，用於指定撰寫的電子郵件是獨立或回覆草稿。
ContentType	列舉值，用於指定 UpdateDraftActionResponse 產生的內容類型。
DatePicker	可輸入日期的輸入欄位。
DateTimePicker	可讓使用者輸入日期和時間的輸入欄位。
DecoratedText	顯示文字搭配選用裝飾的小工具。
Dialog	詳情請參閱 Google Chat 說明文件中的「開啟互動式對話方塊」。
DialogAction	DialogAction 物件的建構工具。
DisplayStyle	定義資訊卡顯示樣式的列舉。
Divider	水平分隔線。
DriveItemsSelectedActionResponse	代表在選取雲端硬碟項目時變更雲端硬碟內容，以及回應使用者介面中特定動作 (例如按下按鈕) 的回應。
DriveItemsSelectedActionResponseBuilder	DriveItemsSelectedActionResponse 物件的建構工具。
EditorFileScopeActionResponse	變更編輯器，例如 Google 文件、試算表或簡報，回應 UI 中執行的動作。
EditorFileScopeActionResponseBuilder	EditorFileScopeActionResponse 物件的建構工具。
FixedFooter	顯示在 Card 底部的固定頁尾。
Grid	顯示格線項目集合的組織格。
GridItem	使用者在格狀小工具中互動的項目。
GridItemLayout	定義 GridItem 圖片和文字樣式的列舉。
HorizontalAlignment	指定小工具水平對齊方式的列舉。
HorizontalSizeStyle	設定小工具如何填滿資料欄空間的列舉項目。
HostAppDataSource	如果 SelectionInput 小工具使用複選選單，也就是來自 Google Workspace 應用程式的資料來源。
Icon	可用於各種 UI 物件 (例如 ImageButton 或 DecoratedText 小工具) 的預先定義圖示。
IconImage	預先定義的圖示、質感設計圖示，或包含可自訂裁剪樣式的網址圖示。
Image	顯示單張圖片的小工具。
ImageButton	包含圖片的 ImageButton。
ImageComponent	可新增至格線項目的圖片元件。
ImageCropStyle	代表可套用至圖片元件的裁剪樣式的類別。
ImageCropType	列舉代表套用至圖片元件的裁剪樣式。
ImageStyle	定義圖片裁剪樣式的列舉。
Interaction	列舉類型，用於指定回應使用者互動時 (例如使用者點擊資訊卡訊息中的按鈕) 時要採取的行動。
KeyValue	這個類別已淘汰，
LinkPreview	在代管應用程式中顯示連結預覽資訊卡和智慧型方塊的資訊卡動作。
LoadIndicator	一種列舉類型，用於指定處理 Action 時要顯示的載入類型或進度指標類型。
Navigation	控制資訊卡導覽的輔助物件。
Notification	向使用者顯示的通知，做為與 UI 元素互動的回應。
OnClose	列舉用於指定在透過 OpenLink 開啟的網址關閉時，要執行的動作。
OpenAs	指定如何開啟網址的列舉。
OpenLink	代表開啟連結的動作和部分選項。
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	可讓使用者輸入時間的輸入欄位。
UniversalActionResponse	從建立通用動作的方法中可能傳回的回應物件。
UniversalActionResponseBuilder	UniversalActionResponse 物件的建構工具。
UpdateDraftActionResponse	代表一項動作，會更新使用者正在編輯的電子郵件草稿。
UpdateDraftActionResponseBuilder	UpdateDraftActionResponse 物件的建構工具。
UpdateDraftBccRecipientsAction	更新電子郵件草稿的密件副本收件者。
UpdateDraftBodyAction	更新電子郵件草稿內文。
UpdateDraftBodyType	指定 UpdateDraftBodyAction 類型的列舉值。
UpdateDraftCcRecipientsAction	更新電子郵件草稿的副本收件者。
UpdateDraftSubjectAction	更新電子郵件草稿的主旨行。
UpdateDraftToRecipientsAction	更新電子郵件草稿的收件者。
UpdatedWidget	更新小工具的回應。
VerticalAlignment	列舉可設定資料欄中小工具的垂直對齊方式。
Widget	所有可新增至 Card 的小工具的基礎類別。
WrapStyle	列舉可為資料欄內的內容設定包裝樣式。

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	設定在點選物件時開啟的網址。

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	將指定的小工具加入此部分。
setCollapsible(collapsible)	CardSection	設定是否可收合。
setHeader(header)	CardSection	設定版面的標題。
setNumUncollapsibleWidgets(numUncollapsibleWidgets)	CardSection	設定當此區段收合時，仍顯示的小工具數量。

CardService

屬性

屬性	類型	說明
BorderType	BorderType	BorderType 列舉。
ComposedEmailType	ComposedEmailType	ComposedEmailType 列舉。
ContentType	ContentType	ContentType 列舉。
GridItemLayout	GridItemLayout	GridItemLayout 列舉。
HorizontalAlignment	HorizontalAlignment	HorizontalAlignment 列舉。
Icon	Icon	Icon 列舉。
ImageCropType	ImageCropType	ImageCropType 列舉。
ImageStyle	ImageStyle	ImageStyle 列舉。
LoadIndicator	LoadIndicator	LoadIndicator 列舉。
OnClose	OnClose	OnClose 列舉。
OpenAs	OpenAs	OpenAs 列舉。
SelectionInputType	SelectionInputType	SelectionInputType 列舉。
TextButtonStyle	TextButtonStyle	TextButtonStyle 列舉。
UpdateDraftBodyType	UpdateDraftBodyType	UpdateDraftBodyType 列舉。

方法

方法	傳回類型	簡短說明
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	建立新的 CardBuilder。
newCardHeader()	CardHeader	建立新的 CardHeader。
newCardSection()	CardSection	建立新的 CardSection。
newCardWithId()	CardWithId	建立新的 CardWithId。
newChatActionResponse()	ChatActionResponse	建立新的 ChatActionResponse。
newChatResponseBuilder()	ChatResponseBuilder	建立新的 ChatResponseBuilder。
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。
newIconImage()	IconImage	建立新的 IconImage。
newImage()	Image	建立新的 Image。
newImageButton()	ImageButton	建立新的 ImageButton。
newImageComponent()	ImageComponent	建立新的 ImageComponent。
newImageCropStyle()	ImageCropStyle	建立新的 ImageCropStyle。
newKeyValue()	KeyValue	建立新的 KeyValue。
newLinkPreview()	LinkPreview	建立新的 LinkPreview。
newNavigation()	Navigation	建立新的 Navigation。
newNotification()	Notification	建立新的 Notification。
newOpenLink()	OpenLink	建立新的 OpenLink。
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。

CardWithId

方法

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

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 聊天室做為項目。

Column

方法

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

Columns

方法

方法	傳回類型	簡短說明
addColumn(column)	Columns	將 Column 新增至「欄」小工具。
setWrapStyle(wrapStyle)	Columns	設定資料欄的包裝樣式，控制資料欄如何根據螢幕寬度調整大小。

CommonDataSource

屬性

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

ComposeActionResponse

方法

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

ComposeActionResponseBuilder

方法

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

ComposedEmailType

屬性

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

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 互動時產生的事件物件中識別這個挑選器。
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	建立目前的雲端硬碟動作回應。
requestFileScope(itemId)	DriveItemsSelectedActionResponseBuilder	指出回應要求雲端硬碟中與內容相關的項目檔案範圍。

EditorFileScopeActionResponse

方法

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

EditorFileScopeActionResponseBuilder

方法

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

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 的資料來源。

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	設定圖片的裁剪樣式。

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	設定用於作為按鈕圖示的圖片網址。
setOnClickAction(action)	ImageButton	設定在點選物件時要執行的動作。
setOnClickOpenLinkAction(action)	ImageButton	設定當使用者點選物件時，於分頁中開啟網址的動作。
setOpenLink(openLink)	ImageButton	設定在點選物件時開啟的網址。

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	裁剪成圓形。

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	請勿使用指標。

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	設定要開啟的網址。

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	靜態或動態資料的複選選單。

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	設定是否要停用按鈕。
setOnClickAction(action)	TextButton	設定在點選物件時要執行的動作。
setOnClickOpenLinkAction(action)	TextButton	設定當使用者點選物件時，於分頁中開啟網址的動作。
setOpenLink(openLink)	TextButton	設定在點選物件時開啟的網址。
setText(text)	TextButton	設定按鈕上顯示的文字。
setTextButtonStyle(textButtonStyle)	TextButton	設定按鈕樣式。

TextButtonStyle

屬性

屬性	類型	說明
OUTLINED	Enum	一般文字按鈕，背景清晰。
FILLED	Enum	彩色背景的文字按鈕。

TextInput

方法

方法	傳回類型	簡短說明
setFieldName(fieldName)	TextInput	設定鍵，用於識別與 UI 互動時產生的事件物件。
setHint(hint)	TextInput	設定文字輸入的提示。
setMultiline(multiline)	TextInput	設定輸入文字，選擇要在單行或多行中顯示。
setOnChangeAction(action)	TextInput	設定每次文字輸入變更時要執行的動作。
setSuggestions(suggestions)	TextInput	設定文字欄位中自動完成的建議。
setSuggestionsAction(suggestionsAction)	TextInput	設定回呼動作，根據使用者輸入的自動完成建議擷取建議。
setTitle(title)	TextInput	設定要在輸入欄位上方顯示的標題。
setValue(value)	TextInput	設定要在輸入欄位中設定的預先填入值。

TextParagraph

方法

方法	傳回類型	簡短說明
setText(text)	TextParagraph	設定段落文字。

TimePicker

方法

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

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	更新電子郵件草稿的收件者。

UpdatedWidget

方法

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

VerticalAlignment

屬性

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

Widget

WrapStyle

屬性

屬性	類型	說明
NOWRAP	Enum	不使用換行功能。
WRAP	Enum	將所有小工具的內容納入資料欄中。