Card Service

银行卡服务

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

您可以使用 CardService 为 Google Workspace 插件和 Google Chat 应用消息构建基于卡片的界面。

类

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

属性

媒体资源	类型	说明
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	设置更新后的 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 聊天室作为一项内容。

Column

方法

方法	返回类型	简介
addWidget(widget)	Column	向列添加 widget。
setHorizontalAlignment(horizontalAlignment)	Column	设置 Column 的 HorizontalAlignment。
setHorizontalSizeStyle(horizontalSizeStyle)	Column	设置 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	构建当前的 Compose 操作响应并验证该响应。
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	在存在界面互动时生成的事件对象中设置用于标识此选择器的字段名称。
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

属性

媒体资源	类型	说明
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	设置网格项的标识符。
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	将 widget 与句子开头对齐。
CENTER	Enum	将微件居中对齐。
END	Enum	将 widget 与句子的结尾对齐。

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	在存在界面互动时生成的事件对象中设置用于标识此选择输入的键。
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 Client Closed Request
UNKNOWN	Enum	未知错误。
INVALID_ARGUMENT	Enum	客户端指定的参数无效。
DEADLINE_EXCEEDED	Enum	HTTP 映射：504 Gateway Timeout
NOT_FOUND	Enum	HTTP 映射：404 Not Found
ALREADY_EXISTS	Enum	客户端尝试创建的实体已存在。
PERMISSION_DENIED	Enum	HTTP 映射：403 Forbidden
UNAUTHENTICATED	Enum	HTTP 映射：401 Unauthorized
RESOURCE_EXHAUSTED	Enum	HTTP 映射：429 Too Many Requests
FAILED_PRECONDITION	Enum	操作被拒绝，因为系统未处于执行该操作所需的状态。
ABORTED	Enum	操作被取消，通常是由于定序器检查失败或事务中止等并发问题。
OUT_OF_RANGE	Enum	尝试执行的操作已超出有效范围。
UNIMPLEMENTED	Enum	HTTP 映射：501 Not Implemented
INTERNAL	Enum	内部错误。
UNAVAILABLE	Enum	HTTP 映射：503 Service Unavailable
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	在存在界面互动时生成的事件对象中设置用于标识此开关的键。
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	在存在界面互动时生成的事件对象中设置用于标识此文本输入的键。
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_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	将任何 widget 的内容封装在一列中。