Card Service

卡片服务

此服务允许脚本配置和构建界面所需的卡片和 widget 组件及行为。您使用此服务构建的界面结构会自动在桌面设备和移动设备上提供，因此您无需分别开发桌面版界面和移动版界面。

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

类

名称	简介
Action	一种可在界面元素内实现互动性的操作。
ActionResponse	可从回调函数（例如表单响应处理程序）返回的响应对象，用于在客户端上执行一项或多项操作。
ActionResponseBuilder	ActionResponse 对象的构建器。
ActionStatus	一个类，用于表示调用或提交对话框的请求的状态。
Attachment	表示由插件创建的附件。
AuthorizationAction	一种授权操作，点击后会将用户发送到 AuthorizationUrl。
AuthorizationException	可返回的错误，用于触发向用户显示授权卡片。
BorderStyle	表示可应用于 widget 的完整边框样式的类。
BorderType	表示可应用于 widget 的边框类型的枚举。
Button	所有按钮的基类。
ButtonSet	用于存放以行形式显示的一组 Button 对象。
CalendarEventActionResponse	表示一种响应，用于响应界面中的操作（例如点击按钮），对用户当前正在编辑的日历活动进行更改。
CalendarEventActionResponseBuilder	CalendarEventActionResponse 对象的构建器。
Card	表示界面中单个视图的上下文卡片。
CardAction	添加到卡片标题菜单中的可点击菜单项。
CardBuilder	Card 对象的构建器。
CardHeader	Card 的标头。
CardSection	卡片部分用于容纳一组 widget，并在它们之间提供视觉分隔。
CardService	卡片服务提供创建可在不同 Google 可扩展性产品（例如 Google Workspace 插件）中使用的通用卡片的功能。
CardWithId	CardWithId 对象的构建器。
Carousel	轮播界面（也称为滑块）以幻灯片格式轮流显示微件列表，并提供用于前往上一个或下一个微件的按钮。
CarouselCard	可显示为轮播界面项的卡片。
ChatActionResponse	一个类，用于表示聊天应用可用于配置其响应发布方式的参数。
ChatClientDataSource	对于使用多选菜单的 SelectionInput widget，Google Chat 中的数据源。
ChatResponse	Google Chat 中卡片消息的响应对象。
ChatResponseBuilder	ChatResponse 对象的构建器。
ChatSpaceDataSource	一种数据源，用于将 Google Chat 聊天室填充为多选菜单的选择项。
Chip	带有图标和文本标签的 Chip。
ChipList	包含一组以行显示、换行到下一行以实现水平滚动的 Chip 对象。
ChipListLayout	一个枚举，用于指定 ChipList 的布局。
CollapseControl	可自定义的折叠和展开控件。
Column	列。
Columns	Columns widget 最多可在卡片或对话框中显示 2 列。
CommonDataSource	由所有 Google Workspace 应用共享的数据源。
CommonWidgetAction	定义不涉及评估的操作，例如更新 widget 可见性。
ComposeActionResponse	可从 Gmail 加载项中撰写操作的回调方法返回的响应对象。
ComposeActionResponseBuilder	ComposeActionResponse 对象的构建器。
ComposedEmailType	一个枚举值，用于指定撰写的电子邮件是独立草稿还是回复草稿。
Condition	用于运行事件操作的条件，作为 CEL 表达式验证的一部分。
ContentType	一个枚举值，用于指定 UpdateDraftActionResponse 生成的内容的内容类型。
DatePicker	允许输入日期的输入字段。
DateTimePicker	一种输入字段，可让用户输入日期和时间。
DecoratedText	一种用于显示文本的 widget，可选择添加装饰。
Dialog	如需了解详情，请参阅 Google Chat 文档中的打开互动式对话框。
DialogAction	DialogAction 对象的构建器。
DisplayStyle	一种用于定义卡片显示样式的枚举。
Divider	水平分隔线。
DriveItemsSelectedActionResponse	表示在选择云端硬盘内容并对界面中采取的操作（例如点击按钮）做出反应时，对云端硬盘做出更改的响应。
DriveItemsSelectedActionResponseBuilder	DriveItemsSelectedActionResponse 对象的构建器。
EditorFileScopeActionResponse	根据界面中采取的操作，对编辑器（例如 Google 文档、表格或幻灯片）进行更改。
EditorFileScopeActionResponseBuilder	EditorFileScopeActionResponse 对象的构建器。
EventAction	当满足 CEL 表达式验证条件时要运行的 EventAction。
ExpressionData	用于评估表达式的表达式数据
ExpressionDataAction	针对 CEL 表达式验证的操作。
ExpressionDataActionType	表示表达式数据操作类型的枚举。
ExpressionDataCondition	表示 CEL 表达式验证结果。
ExpressionDataConditionType	表示 CEL 表达式是否成功评估。
FixedFooter	显示在 Card 底部的固定页脚。
Grid	用于显示网格项集合的有序网格。
GridItem	用户在网格 widget 中互动的内容。
GridItemLayout	一种枚举，用于定义 GridItem 的图片和文字样式。
HorizontalAlignment	一种用于指定 widget 水平对齐方式的枚举。
HorizontalSizeStyle	一种枚举，用于设置 widget 如何填充列的空间。
HostAppDataSource	对于使用多选菜单的 SelectionInput widget，数据源来自 Google Workspace 应用。
Icon	可在各种界面对象（例如 ImageButton 或 DecoratedText widget）中使用的预定义图标。
IconImage	预定义图标、Material Design 图标或来自网址的图标，具有可自定义的剪裁样式。
Image	显示单张图片的 widget。
ImageButton	显示图片的 ImageButton。
ImageButtonStyle	一种枚举，用于指定 ImageButton 的样式。
ImageComponent	可添加到网格项的图片组件。
ImageCropStyle	一个类，表示可应用于图片组件的裁剪样式。
ImageCropType	一种枚举，用于表示应用于图片组件的剪裁样式。
ImageStyle	用于定义图片裁剪样式的枚举。
InputType	一种用于定义 widget 的输入类型的枚举。
Interaction	一种枚举类型，用于指定在与用户互动时（例如用户点击卡片消息中的按钮）应执行的操作。
KeyValue	此类已弃用。
LinkPreview	在宿主应用中显示链接预览卡片和智能条状标签的卡片操作。
LoadIndicator	一种枚举类型，用于指定在处理 Action 时要显示的加载或进度指示器类型。
MaterialIcon	支持所有 Google 字体图标的对象。
Navigation	用于控制卡片导航的辅助对象。
Notification	作为对用户与界面元素互动的响应而向用户显示的通知。
OnClose	一种枚举，用于指定在关闭通过 OpenLink 打开的网址时应执行的操作。
OpenAs	一个枚举，用于指定如何打开网址。
OpenLink	表示打开链接并提供一些选项的操作。
OverflowMenu	用于保存要在弹出式菜单中显示的 OverflowMenuItem 对象列表。
OverflowMenuItem	带有图标和文本标签的 OverflowMenuItem。
PlatformDataSource	对于使用多选菜单的 SelectionInput widget，数据源来自 Google Workspace。
ResponseType	表示聊天应用响应类型的枚举。
SelectionInput	一个输入字段，允许从一组预定义选项中进行选择。
SelectionInputType	用户可以选择的商品的格式。
Status	表示状态代码的枚举。
Suggestions	用于补充 TextInput widget 的自动补全建议。
SuggestionsResponse	可从建议回调函数返回的响应对象。
SuggestionsResponseBuilder	SuggestionsResponse 对象的构建器。
Switch	支持开启或关闭的界面元素。
SwitchControlType	Switch widget 控制的类型。
TextButton	带有文本标签的 TextButton。
TextButtonStyle	一种枚举，用于指定 TextButton 的样式。
TextInput	一个接受文本输入的输入字段 widget。
TextParagraph	一种显示文本并支持基本 HTML 格式的小部件。
TimePicker	一个输入字段，允许用户输入时间。
Trigger	根据操作规则 ID 运行 CEL 表达式验证 widget 事件操作的触发器。
UniversalActionResponse	可从创建通用操作的方法返回的响应对象。
UniversalActionResponseBuilder	UniversalActionResponse 对象的构建器。
UpdateDraftActionResponse	表示更新用户当前正在编辑的电子邮件草稿的操作。
UpdateDraftActionResponseBuilder	UpdateDraftActionResponse 对象的构建器。
UpdateDraftBccRecipientsAction	更新电子邮件草稿的密送收件人。
UpdateDraftBodyAction	更新电子邮件草稿正文。
UpdateDraftBodyType	用于指定 UpdateDraftBodyAction 类型的枚举值。
UpdateDraftCcRecipientsAction	更新电子邮件草稿的抄送收件人。
UpdateDraftSubjectAction	更新电子邮件草稿的主题行。
UpdateDraftToRecipientsAction	更新电子邮件草稿的“收件人”字段。
UpdateVisibilityAction	更新卡片 widget 的可见性，以显示或隐藏该 widget。
UpdatedWidget	更新后的 widget 的响应。
Validation	一个对象，用于定义所附加微件的验证规则。
VariableButtonSize	表示变量选择器按钮大小的枚举。
VerticalAlignment	一种用于设置列中 widget 垂直对齐方式的枚举。
Visibility	表示 widget 可见性状态的枚举。
Widget	可添加到 Card 的所有 widget 的基类。
WorkflowDataSource	对于 SelectionInput、DateTimePicker 或 TextInput widget，来自 Google Workspace 流的数据源。
WorkflowDataSourceType	表示工作流数据源类型的枚举。
WrapStyle	一种枚举，用于设置列中内容的换行样式。

Action

方法

方法	返回类型	简介
addRequiredWidget(requiredWidget)	Action	添加了相应 widget 的名称，以便此操作能够有效提交。
setAllWidgetsAreRequired(allWidgetsAreRequired)	Action	表示相应操作是否需要来自所有 widget 的输入。
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	设置在点击对象时要打开的网址。
setOverflowMenu(menu)	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	向此卡片添加 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 添加到相应部分。
setCollapseControl(collapseControl)	CardSection	设置版块的可自定义展开和收起按钮。
setCollapsible(collapsible)	CardSection	设置相应部分是否可以收起。
setHeader(header)	CardSection	设置部分的标题。
setNumUncollapsibleWidgets(numUncollapsibleWidgets)	CardSection	设置此部分折叠时仍显示的 widget 数量。

CardService

属性

属性	类型	说明
BorderType	BorderType	BorderType 枚举。
ChipListLayout	ChipListLayout	ChipListLayout 枚举。
ComposedEmailType	ComposedEmailType	ComposedEmailType 枚举。
ContentType	ContentType	ContentType 枚举。
ExpressionDataActionType	ExpressionDataActionType	ExpressionDataActionType 枚举。
ExpressionDataConditionType	ExpressionDataConditionType	ExpressionDataConditionType 枚举。
GridItemLayout	GridItemLayout	GridItemLayout 枚举。
HorizontalAlignment	HorizontalAlignment	HorizontalAlignment 枚举。
Icon	Icon	Icon 枚举。
ImageButtonStyle	ImageButtonStyle	ImageButtonStyle 枚举。
ImageCropType	ImageCropType	ImageCropType 枚举。
ImageStyle	ImageStyle	ImageStyle 枚举。
InputType	InputType	InputType 枚举。
LoadIndicator	LoadIndicator	LoadIndicator 枚举。
OnClose	OnClose	OnClose 枚举。
OpenAs	OpenAs	OpenAs 枚举。
SelectionInputType	SelectionInputType	SelectionInputType 枚举。
TextButtonStyle	TextButtonStyle	TextButtonStyle 枚举。
UpdateDraftBodyType	UpdateDraftBodyType	UpdateDraftBodyType 枚举。
Visibility	Visibility	Visibility 枚举。
WorkflowDataSourceType	WorkflowDataSourceType	WorkflowDataSourceType 枚举。

方法

方法	返回类型	简介
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	创建新的卡构建器。
newCardHeader()	CardHeader	创建新的 CardHeader。
newCardSection()	CardSection	创建新的 CardSection。
newCardWithId()	CardWithId	创建新的 CardWithId。
newCarousel()	Carousel	创建 Carousel。
newCarouselCard()	CarouselCard	创建新的 CarouselCard。
newChatActionResponse()	ChatActionResponse	创建新的 ChatActionResponse。
newChatResponseBuilder()	ChatResponseBuilder	创建新的 ChatResponseBuilder。
newChip()	Chip	创建新的 Chip。
newChipList()	ChipList	创建新的 ChipList。
newCollapseControl()	CollapseControl	创建新的 CollapseControl。
newColumn()	Column	创建新的 Column。
newColumns()	Columns	创建一组新的 Columns。
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	创建新的 ComposeActionResponseBuilder。
newDatePicker()	DatePicker	创建新的 DatePicker。
newDateTimePicker()	DateTimePicker	创建新的 DateTimePicker。
newDecoratedText()	DecoratedText	创建新的 DecoratedText。
newDialog()	Dialog	创建新的 Dialog。
newDialogAction()	DialogAction	创建新的 DialogAction。
newDivider()	Divider	创建新的 Divider。
newDriveItemsSelectedActionResponseBuilder()	DriveItemsSelectedActionResponseBuilder	创建新的 DriveItemsSelectedActionResponseBuilder。
newEditorFileScopeActionResponseBuilder()	EditorFileScopeActionResponseBuilder	创建新的 EditorFileScopeActionResponseBuilder。
newFixedFooter()	FixedFooter	创建新的 FixedFooter。
newGrid()	Grid	创建新的 Grid。
newGridItem()	GridItem	创建新的 GridItem。
newHostAppDataSource()	HostAppDataSource	创建新的 HostAppDataSource 并返回空的 HostAppDataSource。
newIconImage()	IconImage	创建新的 IconImage。
newImage()	Image	创建新的 Image。
newImageButton()	ImageButton	创建新的 ImageButton。
newImageComponent()	ImageComponent	创建新的 ImageComponent。
newImageCropStyle()	ImageCropStyle	创建新的 ImageCropStyle。
newKeyValue()	KeyValue	创建新的 KeyValue。
newLinkPreview()	LinkPreview	创建新的 LinkPreview。
newMaterialIcon()	MaterialIcon	创建新的 MaterialIcon。
newNavigation()	Navigation	创建新的 Navigation。
newNotification()	Notification	创建新的 Notification。
newOpenLink()	OpenLink	创建新的 OpenLink。
newOverflowMenu()	OverflowMenu	创建新的 OverflowMenu。
newOverflowMenuItem()	OverflowMenuItem	创建新的 OverflowMenuItem。
newSelectionInput()	SelectionInput	创建新的 SelectionInput。
newSuggestions()	Suggestions	创建新的 Suggestions。
newSuggestionsResponseBuilder()	SuggestionsResponseBuilder	创建新的 SuggestionsResponseBuilder。
newSwitch()	Switch	创建新的 Switch。
newTextButton()	TextButton	创建新的 TextButton。
newTextInput()	TextInput	创建新的 TextInput。
newTextParagraph()	TextParagraph	创建新的 TextParagraph。
newTimePicker()	TimePicker	创建新的 TimePicker。
newUniversalActionResponseBuilder()	UniversalActionResponseBuilder	创建新的 UniversalActionResponseBuilder。
newUpdateDraftActionResponseBuilder()	UpdateDraftActionResponseBuilder	创建新的 UpdateDraftActionResponseBuilder。
newUpdateDraftBccRecipientsAction()	UpdateDraftBccRecipientsAction	创建新的 UpdateDraftBccRecipientsAction；
newUpdateDraftBodyAction()	UpdateDraftBodyAction	创建新的 UpdateDraftBodyAction。
newUpdateDraftCcRecipientsAction()	UpdateDraftCcRecipientsAction	创建新的 UpdateDraftCcRecipientsAction。
newUpdateDraftSubjectAction()	UpdateDraftSubjectAction	创建新的 UpdateDraftSubjectAction。
newUpdateDraftToRecipientsAction()	UpdateDraftToRecipientsAction	创建新的 UpdateDraftToRecipientsAction。
newValidation()	Validation	创建新的 Validation。

CardWithId

方法

方法	返回类型	简介
setCard(card)	CardWithId	设置 cardWithId 的卡。
setCardId(id)	CardWithId	设置 cardWithId 的唯一卡 ID。

Carousel

方法

方法	返回类型	简介
addCarouselCard(card)	Carousel	添加轮播界面卡片。

CarouselCard

方法

方法	返回类型	简介
addFooterWidget(widget)	CarouselCard	将指定 widget 添加到此轮播卡片的页脚。
addWidget(widget)	CarouselCard	将指定微件添加到此轮播卡片。

ChatActionResponse

方法

方法	返回类型	简介
setDialogAction(dialogAction)	ChatActionResponse	将对话框操作设置为与对话框相关的事件。
setResponseType(responseType)	ChatActionResponse	聊天应用响应的类型。
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 聊天室作为项。

Chip

方法

方法	返回类型	简介
setAltText(altText)	Chip	设置芯片的替代文本，以实现无障碍功能。
setAuthorizationAction(action)	Chip	设置授权操作，以便在点击对象时打开网址以进入授权流程。
setComposeAction(action, composedEmailType)	Chip	设置在点击对象时撰写电子邮件草稿的操作。
setDisabled(disabled)	Chip	设置条状标签是否已停用。
setIcon(icon)	Chip	设置要用作 chip 的图标。
setLabel(label)	Chip	设置 chip 的标题。
setOnClickAction(action)	Chip	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	Chip	设置一项操作，以便在点击对象时在标签页中打开网址。
setOpenLink(openLink)	Chip	设置在点击对象时要打开的网址。

ChipList

方法

方法	返回类型	简介
addChip(chip)	ChipList	添加条状标签。
setLayout(layout)	ChipList	设置 chip 列表布局。

ChipListLayout

属性

属性	类型	说明
WRAPPED	Enum	如果横向空间不足，芯片列表会换行。
HORIZONTAL_SCROLLABLE	Enum	如果芯片无法放入可用空间，则会水平滚动。

CollapseControl

方法

方法	返回类型	简介
setCollapseButton(button)	CollapseControl	设置“收起”按钮显示的 Button。
setExpandButton(button)	CollapseControl	设置“显示更多”按钮的 Button。
setHorizontalAlign(horizontalAlignment)	CollapseControl	设置 CollapseControl 的 HorizontalAlignment。

Column

方法

方法	返回类型	简介
addWidget(widget)	Column	向列添加 widget。
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 用户。

CommonWidgetAction

方法

方法	返回类型	简介
setUpdateVisibilityAction(updateVisibilityAction)	CommonWidgetAction	为 widget 设置更新公开范围操作。

ComposeActionResponse

方法

方法	返回类型	简介
printJson()	String	输出此对象的 JSON 表示形式。

ComposeActionResponseBuilder

方法

方法	返回类型	简介
build()	ComposeActionResponse	构建当前撰写操作响应并对其进行验证。
setGmailDraft(draft)	ComposeActionResponseBuilder	设置使用 GmailMessage.createDraftReply(body) 或类似函数创建的草稿 GmailMessage。

ComposedEmailType

属性

属性	类型	说明
REPLY_AS_DRAFT	Enum	作为对另一条消息的回复的草稿。
STANDALONE_DRAFT	Enum	作为独立邮件的草稿。

Condition

方法

方法	返回类型	简介
setActionRuleId(actionRuleId)	Condition	要运行以响应条件的行动规则的唯一 ID。
setExpressionDataCondition(expressionDataCondition)	Condition	设置用于确定事件操作是否应运行的 CEL 表达式验证条件。

ContentType

属性

属性	类型	说明
TEXT	Enum	表示生成的内容是纯文本。
MUTABLE_HTML	Enum	表示生成的内容采用 HTML 格式。
IMMUTABLE_HTML	Enum	表示生成的内容已格式化为 HTML，但生成后无法修改。

DatePicker

方法

方法	返回类型	简介
setFieldName(fieldName)	DatePicker	设置在发生界面互动时生成的事件对象中用于标识相应选择器的字段名称。
setOnChangeAction(action)	DatePicker	设置一个 Action，每当选择器输入发生变化时，脚本都会执行该 Action。
setTitle(title)	DatePicker	设置显示在输入字段上方的标题。
setValueInMsSinceEpoch(valueMsEpoch)	DatePicker	设置要在输入字段中设置的预填充值。
setValueInMsSinceEpoch(valueMsEpoch)	DatePicker	设置要在输入字段中设置的预填充值。

DateTimePicker

方法

方法	返回类型	简介
setFieldName(fieldName)	DateTimePicker	设置在发生界面互动时生成的事件对象中用于标识相应选择器的字段名称。
setHostAppDataSource(hostAppDataSource)	DateTimePicker	在 Google Workspace 流中，允许输入变量接受流中其他步骤的日期时间输出。
setOnChangeAction(action)	DateTimePicker	设置一个 Action，每当选择器输入发生变化时，脚本都会执行该 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	构建当前的 Drive 操作响应。
requestFileScope(itemId)	DriveItemsSelectedActionResponseBuilder	指定响应请求云端硬盘中与上下文相关联的项的文件范围。

EditorFileScopeActionResponse

方法

方法	返回类型	简介
printJson()	String	输出此对象的 JSON 表示形式。

EditorFileScopeActionResponseBuilder

方法

方法	返回类型	简介
build()	EditorFileScopeActionResponse	构建当前的编辑器操作响应。
requestFileScopeForActiveDocument()	EditorFileScopeActionResponseBuilder	为当前活跃的 Editor 文档请求 drive.file 范围。

EventAction

方法

方法	返回类型	简介
addPostEventTrigger(trigger)	EventAction	添加一个 CEL 表达式验证条件，以便在事件操作运行后进行评估。
setActionRuleId(actionRuleId)	EventAction	为事件操作设置唯一标识符。
setCommonWidgetAction(commonWidgetAction)	EventAction	为 widget 设置通用 widget 操作。
setExpressionDataAction(expressionDataAction)	EventAction	为 widget 设置 CEL 表达式验证数据操作。

ExpressionData

方法

方法	返回类型	简介
addCondition(condition)	ExpressionData	向当前表达式数据添加条件。
addEventAction(eventAction)	ExpressionData	向当前表达式数据添加事件操作。
setExpression(expression)	ExpressionData	设置表达式数据值。
setId(id)	ExpressionData	设置表达式数据 ID。

ExpressionDataAction

方法

方法	返回类型	简介
setActionType(type)	ExpressionDataAction	设置表达式数据操作的类型。

ExpressionDataActionType

属性

属性	类型	说明
ACTION_TYPE_UNSPECIFIED	Enum	未指定的操作类型。
START_EXPRESSION_EVALUATION	Enum	用于启动 CEL 表达式验证的操作。

ExpressionDataCondition

方法

方法	返回类型	简介
setConditionType(type)	ExpressionDataCondition	为 CEL 表达式验证设置条件类型，以指示表达式是否成功评估。

ExpressionDataConditionType

属性

属性	类型	说明
CONDITION_TYPE_UNSPECIFIED	Enum	未指定的条件类型。
EXPRESSION_EVALUATION_SUCCESS	Enum	CEL 表达式的评估结果为成功。
EXPRESSION_EVALUATION_FAILURE	Enum	CEL 表达式的计算结果为失败。

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	将 widget 居中对齐。
END	Enum	将 widget 对齐到句子一侧的末尾。

HorizontalSizeStyle

属性

属性	类型	说明
FILL_AVAILABLE_SPACE	Enum	调整 Widget 的大小，使其填充 Column 的可用水平空间。
FILL_MINIMUM_SPACE	Enum	调整 Widget 的大小，使其填充 Column 中最少的水平空间。

HostAppDataSource

方法

方法	返回类型	简介
setChatDataSource(chatClientDataSource)	HostAppDataSource	设置 Google Chat 中的数据源。
setWorkflowDataSource(workflowDataSource)	HostAppDataSource	设置来自 Google Workspace Flows 的数据源。

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	设置图片的裁剪样式。
setMaterialIcon(icon)	IconImage	设置 Material Design 图标。

Image

方法

方法	返回类型	简介
setAltText(altText)	Image	设置图片的替代文字，以实现无障碍功能。
setAuthorizationAction(action)	Image	设置授权操作，以便在点击对象时打开网址以进入授权流程。
setComposeAction(action, composedEmailType)	Image	设置在点击对象时撰写电子邮件草稿的操作。
setImageUrl(url)	Image	通过提供网址或数据字符串来设置要使用的图片。
setOnClickAction(action)	Image	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	Image	设置一项操作，以便在点击对象时在标签页中打开网址。
setOpenLink(openLink)	Image	设置在点击对象时要打开的网址。

ImageButton

方法

方法	返回类型	简介
setAltText(altText)	ImageButton	设置按钮的替代文本，以实现无障碍功能。
setAuthorizationAction(action)	ImageButton	设置授权操作，以便在点击对象时打开网址以进入授权流程。
setComposeAction(action, composedEmailType)	ImageButton	设置在点击对象时撰写电子邮件草稿的操作。
setIcon(icon)	ImageButton	设置要在按钮上显示的预定义 Icon。
setIconUrl(url)	ImageButton	设置要用作此按钮图标的图片的网址。
setImageButtonStyle(imageButtonStyle)	ImageButton	设置按钮样式。
setMaterialIcon(icon)	ImageButton	设置 Material Design 图标。
setOnClickAction(action)	ImageButton	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	ImageButton	设置一项操作，以便在点击对象时在标签页中打开网址。
setOpenLink(openLink)	ImageButton	设置在点击对象时要打开的网址。
setOverflowMenu(menu)	ImageButton	设置在点击对象时打开的弹出式菜单。

ImageButtonStyle

属性

属性	类型	说明
BORDERLESS	Enum	没有边框的图片按钮。
OUTLINED	Enum	具有透明背景的图片按钮。
FILLED	Enum	带有彩色背景的图片按钮。
FILLED_TONAL	Enum	图片按钮，介于实心按钮和轮廓按钮之间。

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

InputType

属性

属性	类型	说明
TEXT	Enum	接受常规文本。
INTEGER	Enum	接受整数。
FLOAT	Enum	接受浮点数。
EMAIL	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	请勿使用指示器。

MaterialIcon

方法

方法	返回类型	简介
setFill(fill)	MaterialIcon	图标是否以填充状态呈现。
setGrade(grade)	MaterialIcon	粗细和等级会影响符号的粗细。
setName(name)	MaterialIcon	设置图标的名称。
setWeight(weight)	MaterialIcon	图标的描边粗细。

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	设置要打开的网址。

OverflowMenu

方法

方法	返回类型	简介
addMenuItem(menuItem)	OverflowMenu	添加菜单项。

OverflowMenuItem

方法

方法	返回类型	简介
setAuthorizationAction(action)	OverflowMenuItem	设置授权操作，以便在点击对象时打开网址以进入授权流程。
setComposeAction(action, composedEmailType)	OverflowMenuItem	设置在点击对象时撰写电子邮件草稿的操作。
setDisabled(disabled)	OverflowMenuItem	设置菜单项是否已停用。
setOnClickAction(action)	OverflowMenuItem	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	OverflowMenuItem	设置一项操作，以便在点击对象时在标签页中打开网址。
setOpenLink(openLink)	OverflowMenuItem	设置在点击对象时要打开的网址。
setStartIcon(icon)	OverflowMenuItem	设置菜单项的前导图标。
setText(text)	OverflowMenuItem	设置菜单项的标题。

PlatformDataSource

方法

方法	返回类型	简介
setCommonDataSource(commonDataSource)	PlatformDataSource	设置 Google Workspace 中的数据源。
setHostAppDataSource(hostAppDataSource)	PlatformDataSource	用于填充多选菜单中的聊天室。

ResponseType

属性

属性	类型	说明
TYPE_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	用于静态或动态数据的多选菜单。
OVERFLOW_MENU	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	开关 widget 的切换样式控件。
CHECK_BOX	Enum	开关 widget 的复选框样式控件。

TextButton

方法

方法	返回类型	简介
setAltText(altText)	TextButton	设置按钮的替代文本，以实现无障碍功能。
setAuthorizationAction(action)	TextButton	设置授权操作，以便在点击对象时打开网址以进入授权流程。
setBackgroundColor(backgroundColor)	TextButton	设置 TextButtonStyle.FILLED 按钮的背景颜色。
setComposeAction(action, composedEmailType)	TextButton	设置在点击对象时撰写电子邮件草稿的操作。
setDisabled(disabled)	TextButton	设置按钮是否处于停用状态。
setIcon(icon)	TextButton	设置要在按钮上显示的预定义 Icon。
setIconUrl(url)	TextButton	设置要用作此按钮图标的图片的网址。
setMaterialIcon(icon)	TextButton	设置 Material Design 图标。
setOnClickAction(action)	TextButton	设置在点击对象时执行的操作。
setOnClickOpenLinkAction(action)	TextButton	设置一项操作，以便在点击对象时在标签页中打开网址。
setOpenLink(openLink)	TextButton	设置在点击对象时要打开的网址。
setOverflowMenu(menu)	TextButton	设置在点击对象时打开的弹出式菜单。
setText(text)	TextButton	设置按钮上显示的文字。
setTextButtonStyle(textButtonStyle)	TextButton	设置按钮样式。

TextButtonStyle

属性

属性	类型	说明
OUTLINED	Enum	具有透明背景的普通文本按钮。
TEXT	Enum	请勿使用。
FILLED	Enum	带有彩色背景的文字按钮。
FILLED_TONAL	Enum	介于实心按钮和轮廓按钮之间的普通文本按钮。
BORDERLESS	Enum	无边框的普通文本按钮。

TextInput

方法

方法	返回类型	简介
setFieldName(fieldName)	TextInput	设置在发生界面互动时生成的事件对象中用于标识相应文本输入的键。
setHint(hint)	TextInput	为文本输入设置提示。
setHostAppDataSource(hostAppDataSource)	TextInput	设置来自 Google Workspace 应用的数据源。
setMultiline(multiline)	TextInput	设置输入文本是显示在一行还是多行上。
setOnChangeAction(action)	TextInput	设置在每次文本输入发生变化时执行的操作。
setSuggestions(suggestions)	TextInput	设置文本字段中自动补全的建议。
setSuggestionsAction(suggestionsAction)	TextInput	设置回调操作，以根据用户输入的内容获取自动补全建议。
setTitle(title)	TextInput	设置要显示在输入字段上方的标题。
setValidation(validation)	TextInput	为此 widget 设置验证规则。
setValue(value)	TextInput	设置要在输入字段中设置的预填充值。

TextParagraph

方法

方法	返回类型	简介
setMaxLines(maxLines)	TextParagraph	设置 widget 中显示的最大文本行数。
setText(text)	TextParagraph	设置段落的文本。

TimePicker

方法

方法	返回类型	简介
setFieldName(fieldName)	TimePicker	设置在发生界面互动时生成的事件对象中用于标识相应选择器的字段名称。
setHours(hours)	TimePicker	设置要在输入字段中设置的预填充小时值。
setMinutes(minutes)	TimePicker	设置要在输入字段中设置的预填充分钟值。
setOnChangeAction(action)	TimePicker	设置一个 Action，每当选择器输入发生变化时，脚本都会执行该 Action。
setTitle(title)	TimePicker	设置显示在输入字段上方的标题。

Trigger

方法

方法	返回类型	简介
setActionRuleId(actionRuleId)	Trigger	为触发器设置操作规则 ID。

UniversalActionResponse

方法

方法	返回类型	简介
printJson()	String	输出此对象的 JSON 表示形式。

UniversalActionResponseBuilder

方法

方法	返回类型	简介
build()	UniversalActionResponse	构建当前通用操作响应并对其进行验证。
displayAddOnCards(cardObjects)	UniversalActionResponseBuilder	显示具有指定卡片的插件。
setOpenLink(openLink)	UniversalActionResponseBuilder	设置在选择通用操作时要打开的网址。

UpdateDraftActionResponse

方法

方法	返回类型	简介
printJson()	String	输出此对象的 JSON 表示形式。

UpdateDraftActionResponseBuilder

方法

方法	返回类型	简介
build()	UpdateDraftActionResponse	构建当前更新草稿操作响应并对其进行验证。
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)	UpdateDraftActionResponseBuilder	设置用于更新草稿的电子邮件密送收件人的操作。
setUpdateDraftBodyAction(updateDraftBodyAction)	UpdateDraftActionResponseBuilder	设置用于更新草稿电子邮件正文的操作。
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)	UpdateDraftActionResponseBuilder	设置用于更新草稿的抄送收件人的操作。
setUpdateDraftSubjectAction(updateDraftSubjectAction)	UpdateDraftActionResponseBuilder	设置用于更新草稿主题行的操作。
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)	UpdateDraftActionResponseBuilder	设置用于更新草稿的“收件人”的 action。

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	更新电子邮件草稿的“收件人”字段。

UpdateVisibilityAction

方法

方法	返回类型	简介
setVisibility(visibility)	UpdateVisibilityAction	将 widget 的可见性设置为可见或隐藏。

UpdatedWidget

方法

方法	返回类型	简介
addItem(text, value, selected, startIconUri, bottomText)	UpdatedWidget	添加可供选择的新项。

Validation

方法

方法	返回类型	简介
setCharacterLimit(characterLimit)	Validation	设置 widget 的字符数限制。
setInputType(inputType)	Validation	设置 widget 的输入类型。

VariableButtonSize

属性

属性	类型	说明
UNSPECIFIED	Enum	自动为侧边栏选择 COMPACT，否则选择 FULL_SIZE。
COMPACT	Enum	对于标有“+”的按钮
FULL_SIZE	Enum	对于标有“+ 变量”的按钮

VerticalAlignment

属性

属性	类型	说明
CENTER	Enum	将内容垂直放置在容器的中心。
TOP	Enum	将内容垂直放置在容器顶部。
BOTTOM	Enum	将内容垂直放置在容器底部。

Visibility

属性

属性	类型	说明
VISIBLE	Enum	界面元素可见。
HIDDEN	Enum	界面元素不可见。
VISIBILITY_UNSPECIFIED	Enum	未指定界面元素。

Widget

WorkflowDataSource

方法

方法	返回类型	简介
setIncludeVariables(includeVariables)	WorkflowDataSource	是否在数据源中包含上一步中的变量。
setType(type)	WorkflowDataSource	设置工作流数据源的类型。
setVariableButtonLabel(variableButtonLabel)	WorkflowDataSource	设置变量选择器按钮的标签，该标签将在 FULL_SIZE 按钮大小的“+”号后显示。
setVariableButtonSize(variableButtonSize)	WorkflowDataSource	设置变量选择器按钮的大小，如果选择 UNSPECIFIED，工作流将在侧边栏中自动使用 COMPACT，在其他情况下使用 FULL_SIZE。

WorkflowDataSourceType

属性

属性	类型	说明
UNKNOWN	Enum	默认值。
USER	Enum	数据源是用户的数据。
SPACE	Enum	数据源是 Google Chat 聊天室。
USER_WITH_FREE_FORM	Enum	数据源是用户的数据；用户可以选择查看和选择 Google Workspace 组织中的现有成员，也可以手动输入电子邮件地址或有效网域。

WrapStyle

属性

属性	类型	说明
NOWRAP	Enum	不换行。
WRAP	Enum	使列中所有 widget 的内容换行。