Card Service

银行卡服务

此服务允许脚本为界面配置和构建卡片和 widget 组件及行为。您使用此服务构建的界面结构会自动在桌面设备和移动设备上使用,因此您无需为这两者开发单独的界面。

名称简介
Action能够在界面元素内实现互动的操作。
ActionResponse可能从回调函数(例如,表单响应处理程序)返回的响应对象,用于在客户端上执行一项或多项操作。
ActionResponseBuilderActionResponse 对象的构建器。
ActionStatus
Attachment表示由插件创建的附件。
AuthorizationAction一项授权操作,点击后会将用户转到 AuthorizationUrl。
AuthorizationException可以返回以触发向用户显示授权卡的错误。
BorderStyle表示可应用于微件的完整边框样式的类。
BorderType表示可应用于微件的边框类型的枚举。
Button所有按钮的基类。
ButtonSet存放在一行中显示的一组 Button 对象。
CalendarEventActionResponse表示对用户当前正在修改的日历活动做出的响应,以响应界面中执行的操作(例如点击按钮)。
CalendarEventActionResponseBuilderCalendarEventActionResponse 对象的构建器。
Card表示界面中的单个视图的上下文卡片。
CardAction一个会添加到卡片标题菜单中的可点击菜单项。
CardBuilderCard 对象的构建器。
CardHeaderCard 的标头。
CardSection卡片部分包含多组 widget,并在视觉上区分这些 widget。
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 文档、表格或幻灯片)进行更改。
EditorFileScopeActionResponseBuilderEditorFileScopeActionResponse 对象的构建器。
FixedFooterCard 底部显示的固定页脚。
Grid井然有序的网格,用于显示一系列网格项。
GridItem用户在网格 widget 中与之互动的项。
GridItemLayout用于定义 GridItem 的图片和文本样式的枚举。
HorizontalAlignment一个枚举,用于指定 widget 的水平对齐方式。
HostAppDataSource
Icon可在各种界面对象(例如 ImageButtonDecoratedText widget)中使用的预定义图标。
IconImage预定义的图标或网址中的图标,剪裁样式可自定义。
Image显示单张图片的微件。
ImageButton显示有图片的 ImageButton
ImageComponent一种可添加到网格项中的图片组件。
ImageCropStyle表示可应用于图片组件的剪裁样式的类。
ImageCropType表示应用于图片组件的剪裁样式的枚举。
ImageStyle用于定义图片剪裁样式的枚举。
Interaction
KeyValue此类已废弃。
LinkPreview在托管应用中显示链接预览卡片和智能条状标签的卡片操作。
LoadIndicator一种枚举类型,用于指定处理 Action 时要显示的加载类型或进度指示器。
Navigation用于控制卡片导航的辅助对象。
Notification作为对与界面元素交互的响应而向用户显示的通知。
OnClose一个枚举,用于指定在通过 OpenLink 打开的网址关闭时要执行的操作。
OpenAs指定如何打开网址的枚举。
OpenLink表示用于打开包含某些选项的链接的操作。
PlatformDataSource
ResponseType
SelectionInput用于在一组预定义选项之间进行选择的输入字段。
SelectionInputType用户可以选择的内容的格式。
Status表示状态代码的枚举。
Suggestions用于补充 TextInput widget 的自动补全建议。
SuggestionsResponse可从建议回调函数返回的响应对象。
SuggestionsResponseBuilderSuggestionsResponse 对象的构建器。
Switch支持开启或关闭的界面元素。
SwitchControlTypeSwitch widget 控件的类型。
TextButton带有文本标签的 TextButton
TextButtonStyle一个枚举,用于指定 TextButton 的样式。
TextInput接受文本输入的输入字段 widget。
TextParagraph一个显示文本并支持基本 HTML 格式的微件。
TimePicker允许用户输入时间的输入字段。
UniversalActionResponse可从创建通用操作的方法返回的响应对象。
UniversalActionResponseBuilderUniversalActionResponse 对象的构建器。
UpdateDraftActionResponse表示更新用户当前正在编辑的电子邮件草稿的操作。
UpdateDraftActionResponseBuilderUpdateDraftActionResponse 对象的构建器。
UpdateDraftBccRecipientsAction更新电子邮件草稿的密送收件人。
UpdateDraftBodyAction更新电子邮件草稿正文。
UpdateDraftBodyType用于指定 UpdateDraftBodyAction 类型的枚举值。
UpdateDraftCcRecipientsAction更新电子邮件草稿的抄送收件人。
UpdateDraftSubjectAction更新电子邮件草稿的主题行。
UpdateDraftToRecipientsAction更新电子邮件草稿的收件人。
UpdatedWidget
Widget可添加到 Card 的所有 widget 的基类。

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指定在执行关联的界面操作时,响应应将附件添加到日历活动。
addAttendees(emails)CalendarEventActionResponseBuilder指定在执行关联的界面操作时,响应应将指定的参加者添加到日历活动中。
build()CalendarEventActionResponse构建当前的日历活动操作响应并验证该响应。
setConferenceData(conferenceData)CalendarEventActionResponseBuilder指定在执行关联的界面操作时,响应应将指定的会议数据设置为日历活动。

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向此 Card 添加 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向此部分添加指定的 widget。
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设置更新后的 widget,用于为 widget 提供自动补全选项。
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构建当前的 Compose 操作响应并验证该响应。
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在存在界面互动时生成的事件对象中设置用于标识此选择器的字段名称。
setOnChangeAction(action)DatePicker设置每当选择器输入发生更改时脚本执行的 Action
setTitle(title)DatePicker设置输入字段上方显示的标题。
setValueInMsSinceEpoch(valueMsEpoch)DatePicker设置要在输入字段中设置的预填充值。
setValueInMsSinceEpoch(valueMsEpoch)DatePicker设置要在输入字段中设置的预填充值。

DateTimePicker

方法

方法返回类型简介
setFieldName(fieldName)DateTimePicker在存在界面互动时生成的事件对象中设置用于标识此选择器的字段名称。
setOnChangeAction(action)DateTimePicker设置每当选择器输入发生更改时脚本执行的 Action
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePicker设置时区与世界协调时间 (UTC) 的偏差(分钟数)。
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设置网格项的标识符。
setImage(image)GridItem设置此网格项的图片。
setLayout(layout)GridItem设置网格项的文本和图片的布局。
setSubtitle(subtitle)GridItem设置网格项的副标题。
setTextAlignment(alignment)GridItem设置网格项的水平对齐方式。
setTitle(title)GridItem设置网格项的标题文本。

GridItemLayout

属性

媒体资源类型说明
TEXT_BELOWEnum标题和副标题会显示在网格项的图片下方。
TEXT_ABOVEEnum标题和副标题显示在网格项的图片上方。

HorizontalAlignment

属性

媒体资源类型说明
STARTEnum将 widget 与句子开头对齐。
CENTEREnum将微件居中对齐。
ENDEnum将 widget 与句子的结尾对齐。

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在存在界面互动时生成的事件对象中设置用于标识此选择输入的键。
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 Client Closed Request
UNKNOWNEnum未知错误。
INVALID_ARGUMENTEnum客户端指定的参数无效。
DEADLINE_EXCEEDEDEnumHTTP 映射:504 Gateway Timeout
NOT_FOUNDEnumHTTP 映射:404 Not Found
ALREADY_EXISTSEnum客户端尝试创建的实体已存在。
PERMISSION_DENIEDEnumHTTP 映射:403 Forbidden
UNAUTHENTICATEDEnumHTTP 映射:401 Unauthorized
RESOURCE_EXHAUSTEDEnumHTTP 映射:429 Too Many Requests
FAILED_PRECONDITIONEnum操作被拒绝,因为系统未处于执行该操作所需的状态。
ABORTEDEnum操作被取消,通常是由于定序器检查失败或事务中止等并发问题。
OUT_OF_RANGEEnum尝试执行的操作已超出有效范围。
UNIMPLEMENTEDEnumHTTP 映射:501 Not Implemented
INTERNALEnum内部错误。
UNAVAILABLEEnumHTTP 映射:503 Service Unavailable
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在存在界面互动时生成的事件对象中设置用于标识此开关的键。
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在存在界面互动时生成的事件对象中设置用于标识此文本输入的键。
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在存在界面互动时生成的事件对象中设置用于标识此选择器的字段名称。
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