Card Service

银行卡服务

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

目前，此服务只能与 Google Workspace 插件搭配使用。

类

名称	简介
Action	一种用于在界面元素内实现交互的操作。
ActionResponse	可能会从回调函数（例如表单响应处理程序）返回的响应对象，用于对客户端执行一项或多项操作。
ActionResponseBuilder	ActionResponse 对象的构建器。
Attachment	表示由插件创建的附件。
AuthorizationAction	一种授权操作，会在点击时将用户转到 AuthorizationUrl。
AuthorizationException	可能会返回的错误，可以触发向用户显示授权卡。
BorderStyle	表示可应用于微件的完整边框样式的类。
BorderType	表示可以应用于微件的边框类型的枚举。
Button	所有按钮的基类。
ButtonSet	保存一组 Button，这些对象显示在一行中。
CalendarEventActionResponse	表示响应用户当前正在修改的日历活动（例如，点击某个按钮的操作）而做出的响应。
CalendarEventActionResponseBuilder	CalendarEventActionResponse 对象的构建器。
Card	表示界面中单个视图的上下文卡片。
CardAction	添加到卡片标题菜单中的可点击菜单项。
CardBuilder	Card 对象的构建器。
CardHeader	Card 的标头。
CardSection	卡片部分包含微件组，并在它们之间提供视觉间隔。
CardService	CardService 让您能够创建用于各种 Google 扩展产品（例如 Google Workspace 插件）的通用卡片。
ComposeActionResponse	可通过 Gmail 插件中用于撰写操作的回调方法返回的响应对象。
ComposeActionResponseBuilder	ComposeActionResponse 对象的构建器。
ComposedEmailType	一个枚举值，用于指定撰写的电子邮件是独立草稿还是回复草稿。
ContentType	用于指定 UpdateDraftActionResponse 所生成内容的内容类型的枚举值。
DatePicker	允许输入日期的输入字段。
DateTimePicker	允许用户输入日期和时间的输入字段。
DecoratedText	一个微件，用于显示具有可选装饰的文本。
DisplayStyle	用于定义卡片显示样式的枚举。
Divider	水平分隔线。
DriveItemsSelectedActionResponse	表示在选择云端硬盘内容后更改云端硬盘的响应，是用户对界面（例如按钮点击）执行的操作进行响应。
DriveItemsSelectedActionResponseBuilder	DriveItemsSelectedActionResponse 对象的构建器。
EditorFileScopeActionResponse	对编辑器（如 Google 文档、表格或幻灯片）进行修改，以响应在界面中执行的操作。
EditorFileScopeActionResponseBuilder	EditorFileScopeActionResponse 对象的构建器。
FixedFooter	插件 Card 中显示的固定页脚。
Grid	井然有序的网格，用于显示一组网格项。
GridItem	用户在网格微件内与之互动的项。
GridItemLayout	用于定义 GridItem 的图片和文本样式的枚举。
HorizontalAlignment	用于指定微件水平对齐方式的枚举。
Icon	可在各种界面对象（如 ImageButton 或 DecoratedText 微件）中使用的预定义图标。
IconImage	预定义图标或来自网址（具有可自定义的剪裁样式）的图标。
Image	显示单张图片的微件。
ImageButton	包含图片的 ImageButton。
ImageComponent	一种可添加到网格项的图片组件。
ImageCropStyle	表示可应用于图片组件的剪裁样式的类。
ImageCropType	表示应用于图片组件的剪裁样式的枚举。
ImageStyle	用于定义图片剪裁样式的枚举。
KeyValue	此类已弃用。
LoadIndicator	用于指定在处理 Action 时显示的加载类型或进度指示器的枚举类型。
Navigation	用于控制卡片导航的辅助对象。
Notification	作为与界面元素互动的响应而显示的通知。
OnClose	枚举通过 OpenLink 打开的网址关闭时要执行的操作。
OpenAs	用于指定如何打开网址的枚举。
OpenLink	表示用于打开带有某些选项的链接的操作。
SelectionInput	允许在一组预定义选项之间进行选择的输入字段。
SelectionInputType	选择输入类型。
Suggestions	自动补全建议以补充 TextInput 微件。
SuggestionsResponse	可以从建议回调函数返回的响应对象。
SuggestionsResponseBuilder	SuggestionsResponse 对象的构建器。
Switch	支持启用或停用的界面元素。
SwitchControlType	Switch widget 控件的类型。
TextButton	带有文本标签的 TextButton。
TextButtonStyle	用于指定 TextButton 样式的枚举。
TextInput	一个接受文本输入的输入字段微件。
TextParagraph	显示文本并支持基本 HTML 格式的微件。
TimePicker	允许用户输入时间的输入字段。
UniversalActionResponse	可通过创建通用操作的方法返回的响应对象。
UniversalActionResponseBuilder	UniversalActionResponse 对象的构建器。
UpdateDraftActionResponse	表示用于更新用户当前正在修改的电子邮件草稿的操作。
UpdateDraftActionResponseBuilder	UpdateDraftActionResponse 对象的构建器。
UpdateDraftBccRecipientsAction	更新电子邮件草稿的密送收件人。
UpdateDraftBodyAction	更新电子邮件草稿正文。
UpdateDraftBodyType	用于指定 UpdateDraftBodyAction 类型的枚举值。
UpdateDraftCcRecipientsAction	更新电子邮件草稿的抄送收件人。
UpdateDraftSubjectAction	更新电子邮件草稿的主题行。
UpdateDraftToRecipientsAction	更新电子邮件草稿的收件人。
Widget	所有可添加到 Card 的微件的基类。

Action

方法

方法	返回类型	简介
setFunctionName(functionName)	Action	设置要调用的回调函数的名称。
setLoadIndicator(loadIndicator)	Action	设置在操作过程中显示的加载指示器。
setParameters(parameters)	Action	允许向回调函数传递自定义参数。

ActionResponse

方法

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

ActionResponseBuilder

方法

方法	返回类型	简介
build()	ActionResponse	构建当前操作响应并验证其响应。
setNavigation(navigation)	ActionResponseBuilder	设置对 Navigation 操作的响应。
setNotification(notification)	ActionResponseBuilder	设置在操作激活时显示的通知。
setOpenLink(openLink)	ActionResponseBuilder	设置激活操作后要转到的网址。
setStateChanged(stateChanged)	ActionResponseBuilder	设置指示该操作已改变现有数据状态的标志。

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	向此卡添加 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。
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。
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	创建新的 ComposeActionResponseBuilder。
newDatePicker()	DatePicker	创建新的 DatePicker。
newDateTimePicker()	DateTimePicker	创建新的 DateTimePicker。
newDecoratedText()	DecoratedText	创建新的 DecoratedText。
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。
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。

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	设置值文本应显示在单行还是多行。

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	将微件与句子一侧的开头对齐。
CENTER	Enum	将微件与中心对齐。
END	Enum	将微件与句子一侧的末尾对齐。

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

KeyValue

方法

方法	返回类型	简介
setAuthorizationAction(action)	KeyValue	设置一项授权操作，以在点击对象时打开授权流程的网址。
setComposeAction(action, composedEmailType)	KeyValue	设置在用户点击对象时撰写电子邮件草稿的操作。
setOnClickAction(action)	KeyValue	设置在用户点击对象时执行的操作。
setOnClickOpenLinkAction(action)	KeyValue	设置在用户点击对象时在标签页中打开网址的操作。
setOpenLink(openLink)	KeyValue	设置在用户点击对象时打开的网址。

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

SelectionInput

方法

方法	返回类型	简介
addItem(text, value, selected)	SelectionInput	添加可选择的新内容。
setFieldName(fieldName)	SelectionInput	设置用于在有界面互动时生成的事件对象中标识此选择输入的键。
setOnChangeAction(action)	SelectionInput	设置每当选择输入更改时要执行的 Action。
setTitle(title)	SelectionInput	设置要在输入字段之前显示的标题。
setType(type)	SelectionInput	设置此输入源的类型。

SelectionInputType

属性

属性	类型	说明
CHECK_BOX	Enum	复选框输入样式。
RADIO_BUTTON	Enum	收音机频道输入样式。
DROPDOWN	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

属性

属性	类型	说明
TEXT	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	更新电子邮件草稿的收件人。

Widget