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 外掛程式) 的一般資訊卡。
CardWithId
ChatActionResponse
ChatClientDataSource
ChatResponse
ChatResponseBuilder
ChatSpaceDataSource
CommonDataSource
ComposeActionResponse您在 Gmail 外掛程式中撰寫動作的回呼方法可能傳回的回應物件。
ComposeActionResponseBuilderComposeActionResponse 物件的建構工具。
ComposedEmailType列舉值,用於指定撰寫的電子郵件是獨立或回覆草稿。
ContentType列舉值,用於指定 UpdateDraftActionResponse 產生的內容類型。
DatePicker可輸入日期的輸入欄位。
DateTimePicker可讓使用者輸入日期和時間的輸入欄位。
DecoratedText顯示文字搭配選用裝飾的小工具。
Dialog
DialogAction
DisplayStyle定義資訊卡顯示樣式的列舉。
Divider水平分隔線。
DriveItemsSelectedActionResponse代表在選取雲端硬碟項目時變更雲端硬碟內容,以及回應使用者介面中特定動作 (例如按下按鈕) 的回應。
DriveItemsSelectedActionResponseBuilderDriveItemsSelectedActionResponse 物件的建構工具。
EditorFileScopeActionResponse變更編輯器,例如 Google 文件、試算表或簡報,回應 UI 中執行的動作。
EditorFileScopeActionResponseBuilderEditorFileScopeActionResponse 物件的建構工具。
FixedFooter顯示在 Card 底部的固定頁尾。
Grid顯示格線項目集合的組織格。
GridItem使用者在格狀小工具中互動的項目。
GridItemLayout定義 GridItem 圖片和文字樣式的列舉。
HorizontalAlignment指定小工具水平對齊方式的列舉。
HostAppDataSource
Icon可用於各種 UI 物件 (例如 ImageButtonDecoratedText 小工具) 的預先定義圖示。
IconImage網址中的預先定義圖示或圖示,具有可自訂的裁剪樣式。
Image顯示單張圖片的小工具。
ImageButton包含圖片的 ImageButton
ImageComponent可新增至格線項目的圖片元件。
ImageCropStyle代表可套用至圖片元件的裁剪樣式的類別。
ImageCropType列舉代表套用至圖片元件的裁剪樣式。
ImageStyle定義圖片裁剪樣式的列舉。
Interaction
KeyValue這個類別已淘汰,
LinkPreview在代管應用程式中顯示連結預覽資訊卡和智慧型方塊的資訊卡動作。
LoadIndicator一種列舉類型,用於指定處理 Action 時要顯示的載入類型或進度指標類型。
Navigation控制資訊卡導覽的輔助物件。
Notification向使用者顯示的通知,做為與 UI 元素互動的回應。
OnClose列舉用於指定在透過 OpenLink 開啟的網址關閉時,要執行的動作。
OpenAs指定如何開啟網址的列舉。
OpenLink代表開啟連結的動作和部分選項。
PlatformDataSource
ResponseType
SelectionInput允許在一組預先定義的選項之間選擇的輸入欄位。
SelectionInputType使用者可選擇的項目格式。
Status代表狀態碼的列舉。
Suggestions自動完成建議以補充 TextInput 小工具。
SuggestionsResponse可從建議回呼函式傳回的回應物件。
SuggestionsResponseBuilderSuggestionsResponse 物件的建構工具。
Switch支援開啟或關閉的 UI 元素。
SwitchControlTypeSwitch 小工具控制項的類型。
TextButton包含文字標籤的 TextButton
TextButtonStyle指定 TextButton 樣式的列舉。
TextInput接受文字輸入的輸入欄位小工具。
TextParagraph這個小工具會顯示文字,並支援基本 HTML 格式
TimePicker可讓使用者輸入時間的輸入欄位。
UniversalActionResponse從建立通用動作的方法中可能傳回的回應物件。
UniversalActionResponseBuilderUniversalActionResponse 物件的建構工具。
UpdateDraftActionResponse代表一項動作,會更新使用者正在編輯的電子郵件草稿。
UpdateDraftActionResponseBuilderUpdateDraftActionResponse 物件的建構工具。
UpdateDraftBccRecipientsAction更新電子郵件草稿的密件副本收件者。
UpdateDraftBodyAction更新電子郵件草稿內文。
UpdateDraftBodyType指定 UpdateDraftBodyAction 類型的列舉值。
UpdateDraftCcRecipientsAction更新電子郵件草稿的副本收件者。
UpdateDraftSubjectAction更新電子郵件草稿的主旨行。
UpdateDraftToRecipientsAction更新電子郵件草稿的收件者。
UpdatedWidget
Widget所有可新增至 Card 的小工具的基礎類別。

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

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

CardService

屬性

屬性類型說明
BorderTypeBorderTypeBorderType 列舉。
ComposedEmailTypeComposedEmailTypeComposedEmailType 列舉。
ContentTypeContentTypeContentType 列舉。
GridItemLayoutGridItemLayoutGridItemLayout 列舉。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 列舉。
IconIconIcon 列舉。
ImageCropTypeImageCropTypeImageCropType 列舉。
ImageStyleImageStyleImageStyle 列舉。
LoadIndicatorLoadIndicatorLoadIndicator 列舉。
OnCloseOnCloseOnClose 列舉。
OpenAsOpenAsOpenAs 列舉。
SelectionInputTypeSelectionInputTypeSelectionInputType 列舉。
TextButtonStyleTextButtonStyleTextButtonStyle 列舉。
UpdateDraftBodyTypeUpdateDraftBodyTypeUpdateDraftBodyType 列舉。

方法

方法傳回類型簡短說明
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
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)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 聊天室做為項目。

CommonDataSource

屬性

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

ComposeActionResponse

方法

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

ComposeActionResponseBuilder

方法

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

ComposedEmailType

屬性

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

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 互動時產生的事件物件中識別這個挑選器。
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建立目前的雲端硬碟動作回應。
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_BELOWEnum標題和副標題會顯示在格線項目圖片下方。
TEXT_ABOVEEnum標題和副標題會顯示在格線項目圖片上方。

HorizontalAlignment

屬性

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

HostAppDataSource

方法

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

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

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

屬性

屬性類型說明
SQUAREEnum正方形形狀裁剪樣式。
CIRCLEEnum圓形形狀裁剪樣式。
RECTANGLE_CUSTOMEnum具有自訂比例的矩形裁剪樣式。
RECTANGLE_4_3Enum矩形裁剪樣式,長寬比為 4:3。

ImageStyle

屬性

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

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

方法

方法傳回類型簡短說明
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設定要開啟的網址。

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

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

TextButtonStyle

屬性

屬性類型說明
OUTLINEDEnum一般文字按鈕,背景清晰。
FILLEDEnum彩色背景的文字按鈕。

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

UpdateDraftCcRecipientsAction

方法

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

UpdateDraftSubjectAction

方法

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

UpdateDraftToRecipientsAction

方法

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

UpdatedWidget

方法

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

Widget