Card Service

卡片服务

借助此服务,脚本可以配置和构建界面的卡片和 widget 组件以及行为。您使用此服务构建的界面结构会自动在桌面设备和移动设备上提供,因此您无需为这两种设备分别开发界面。

名称简介
Action用于在界面元素中启用交互性的操作。
ActionResponse可从回调函数(例如表单响应处理脚本)返回的响应对象,用于在客户端执行一项或多项操作。
ActionResponseBuilderActionResponse 对象的构建器。
ActionStatus表示调用或提交对话框请求的状态的类。
Attachment表示由插件创建的附件。
AuthorizationAction一种授权操作,点击后会将用户发送到 AuthorizationUrl。
AuthorizationException可返回的错误,用于触发向用户显示授权卡片。
BorderStyle表示可应用于 widget 的完整边框样式的类。
BorderType表示可应用于 widget 的边框类型的枚举。
Button所有按钮的基类。
ButtonSet用于存储一组并排显示的 Button 对象。
CalendarEventActionResponse表示对用户当前正在修改的日历活动进行更改的响应,以响应在界面中执行的操作(例如按钮点击)。
CalendarEventActionResponseBuilderCalendarEventActionResponse 对象的构建器。
Card表示界面中单个视图的情境卡片
CardAction添加到卡片标题菜单中的可点击菜单项。
CardBuilderCard 对象的构建器。
CardHeaderCard 的标头。
CardSection卡片部分用于容纳一组微件,并在它们之间提供视觉分隔。
CardService借助 CardService,您可以创建在各种 Google 可扩展性产品(例如 Google Workspace 插件)中使用的通用卡片。
CardWithIdCardWithId 对象的构建器。
ChatActionResponse一个类,表示 Chat 应用可以使用这些参数来配置其响应的发布方式。
ChatClientDataSource对于使用多选菜单的 SelectionInput 微件,请使用 Google Chat 中的数据源。
ChatResponseGoogle Chat 中卡片消息的响应对象。
ChatResponseBuilderChatResponse 对象的构建器。
ChatSpaceDataSource一种数据源,用于将 Google Chat 聊天室填充为多选菜单的选择项。
Chip带有图标和文本标签的 Chip
ChipList用于存储一组在同一行中显示的 Chip 对象,这些对象会换行到下一行以实现水平滚动。
ChipListLayout用于指定 ChipList 布局的枚举。
CollapseControl可自定义的收起和展开控件。
Column列。
ColumnsColumns widget 在卡片或对话框中最多可显示 2 列。
CommonDataSource所有 Google Workspace 应用共享的数据源。
ComposeActionResponseGmail 插件中用于撰写操作的回调方法可能会返回的响应对象。
ComposeActionResponseBuilderComposeActionResponse 对象的构建器。
ComposedEmailType一个枚举值,用于指定撰写的电子邮件是独立邮件还是回复草稿。
ContentType一个枚举值,用于指定 UpdateDraftActionResponse 生成的内容的内容类型。
DatePicker用于输入日期的输入字段。
DateTimePicker一个输入字段,供用户输入日期和时间。
DecoratedText用于显示带有可选装饰的文本的 widget。
Dialog如需了解详情,请参阅 Google Chat 文档中的打开 Interactive Dialog
DialogActionDialogAction 对象的构建器。
DisplayStyle用于定义卡片显示样式的枚举。
Divider水平分隔线。
DriveItemsSelectedActionResponse表示在选择云端硬盘内容并响应界面中执行的操作(例如点击按钮)时,对云端硬盘进行更改的响应。
DriveItemsSelectedActionResponseBuilderDriveItemsSelectedActionResponse 对象的构建器。
EditorFileScopeActionResponse对 Google 文档、表格或幻灯片等编辑器进行更改,以响应界面中执行的操作。
EditorFileScopeActionResponseBuilderEditorFileScopeActionResponse 对象的构建器。
FixedFooterCard 底部显示的固定页脚。
Grid用于显示一组网格项的有序网格。
GridItem用户在网格微件中与之互动的项。
GridItemLayout用于定义 GridItem 的图片和文本样式的枚举。
HorizontalAlignment用于指定 widget 的水平对齐方式的枚举。
HorizontalSizeStyle用于设置 widget 如何填充列空间的枚举。
HostAppDataSource对于使用多选菜单的 SelectionInput 微件,请使用 Google Workspace 应用中的数据源。
Icon可在各种界面对象(例如 ImageButtonDecoratedText widget)中使用的预定义图标。
IconImage预定义图标、Material Design 图标,或具有可自定义剪裁样式的网址图标。
Image用于显示单张图片的微件。
ImageButton显示图片的 ImageButton
ImageButtonStyle用于指定 ImageButton 的样式的枚举。
ImageComponent可添加到网格项的图片组件。
ImageCropStyle表示可应用于图片组件的剪裁样式的类。
ImageCropType表示应用于图片组件的剪裁样式的枚举。
ImageStyle用于定义图片剪裁样式的枚举。
InputType用于定义微件的输入类型的枚举。
Interaction一个枚举类型,用于指定如何响应与用户的互动,例如用户点击卡片消息中的按钮。
KeyValue此类已废弃。
LinkPreview在托管应用中显示链接预览卡片和智能条状标签的卡片操作。
LoadIndicator一个枚举类型,用于指定在处理 Action 时要显示的加载或进度指示器的类型。
MaterialIcon支持所有 Google 字体图标的对象。
Navigation用于控制卡片导航的辅助对象。
Notification系统在用户与界面元素互动时向用户显示的通知。
OnClose一个枚举,用于指定在通过 OpenLink 打开的网址关闭时执行的操作。
OpenAs用于指定如何打开网址的枚举。
OpenLink表示用于打开链接并显示一些选项的操作。
OverflowMenu用于存储在弹出式菜单中显示的 OverflowMenuItem 对象列表。
OverflowMenuItem带有图标和文本标签的 OverflowMenuItem
PlatformDataSource对于使用多选菜单的 SelectionInput 微件,请使用 Google Workspace 中的数据源。
ResponseType表示 Chat 应用响应类型的枚举。
SelectionInput一个输入字段,可让用户从一组预定义选项中进行选择。
SelectionInputType用户可以选择的项的格式。
Status表示状态代码的枚举。
Suggestions用于补充 TextInput widget 的自动补全建议。
SuggestionsResponse可从建议回调函数返回的响应对象。
SuggestionsResponseBuilderSuggestionsResponse 对象的构建器。
Switch支持开启或关闭的界面元素。
SwitchControlTypeSwitch 微件控件的类型。
TextButton带文本标签的 TextButton
TextButtonStyle用于指定 TextButton 的样式的枚举。
TextInput接受文本输入的输入字段微件。
TextParagraph用于显示文本且支持基本 HTML 格式的 widget。
TimePicker一个输入字段,供用户输入时间。
UniversalActionResponse创建通用操作的方法可能会返回的响应对象。
UniversalActionResponseBuilderUniversalActionResponse 对象的构建器。
UpdateDraftActionResponse表示用于更新用户当前正在修改的电子邮件草稿的操作。
UpdateDraftActionResponseBuilderUpdateDraftActionResponse 对象的构建器。
UpdateDraftBccRecipientsAction更新电子邮件草稿的密送收件人。
UpdateDraftBodyAction更新电子邮件草稿正文。
UpdateDraftBodyType用于指定 UpdateDraftBodyAction 类型的枚举值。
UpdateDraftCcRecipientsAction更新电子邮件草稿的抄送收件人。
UpdateDraftSubjectAction更新电子邮件草稿的主题行。
UpdateDraftToRecipientsAction更新电子邮件草稿的“收件人”名单。
UpdatedWidget更新后的 widget 的响应。
Validation一个对象,用于为其附加的微件定义验证规则。
VerticalAlignment用于设置列中微件的垂直对齐方式的枚举。
Widget可添加到 Card 的所有 widget 的基类。
WrapStyle用于设置列中内容换行样式的枚举。

Action

方法

方法返回类型简介
addRequiredWidget(requiredWidget)Action添加此 Action 需要的微件的名称,以便有效提交。
setAllWidgetsAreRequired(allWidgetsAreRequired)Action指示此 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_BORDEREnum无边框样式。
STROKEEnum描边边框样式。

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设置在该部分收起时仍显示的微件数量。

CardService

属性

属性类型说明
BorderTypeBorderTypeBorderType 枚举。
ChipListLayoutChipListLayoutChipListLayout 枚举。
ComposedEmailTypeComposedEmailTypeComposedEmailType 枚举。
ContentTypeContentTypeContentType 枚举。
GridItemLayoutGridItemLayoutGridItemLayout 枚举。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 枚举。
IconIconIcon 枚举。
ImageButtonStyleImageButtonStyleImageButtonStyle 枚举。
ImageCropTypeImageCropTypeImageCropType 枚举。
ImageStyleImageStyleImageStyle 枚举。
InputTypeInputTypeInputType 枚举。
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创建新的卡片制作工具。
newCardHeader()CardHeader创建新的 CardHeader
newCardSection()CardSection创建新的 CardSection
newCardWithId()CardWithId创建新的 CardWithId
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
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。

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设置聊天消息的文本。

ChatSpaceDataSource

方法

方法返回类型简介
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSource如果设置为 true,多选菜单会默认选择当前的 Google Chat 聊天室作为项。

Chip

方法

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

ChipList

方法

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

ChipListLayout

属性

属性类型说明
WRAPPEDEnum如果横向空间不足,条状标签列表会换行到下一行。
HORIZONTAL_SCROLLABLEEnum如果条状标签无法放入可用空间,则会水平滚动。

CollapseControl

方法

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

Column

Columns

方法

方法返回类型简介
addColumn(column)Columns向“Columns”微件添加了 Column
setWrapStyle(wrapStyle)Columns设置列的换行样式,控制列如何根据屏幕宽度调整大小。

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将微件对齐到句子边的末尾。

HorizontalSizeStyle

属性

属性类型说明
FILL_AVAILABLE_SPACEEnum调整 Widget 的大小,使其填充 Column 的可用水平空间。
FILL_MINIMUM_SPACEEnum调整 Widget 的大小,以填充 Column 中尽可能少的水平空间。

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设置图片的剪裁样式。
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

属性

属性类型说明
BORDERLESSEnum无边框的图片按钮。
OUTLINEDEnum背景清晰的图片按钮。
FILLEDEnum带有彩色背景的图片按钮。
FILLED_TONALEnum图片按钮,介于填充型按钮和轮廓型按钮之间。

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

InputType

属性

属性类型说明
TEXTEnum接受普通文本。
INTEGEREnum接受整数。
FLOATEnum接受浮点数。
EMAILEnum接受电子邮件地址。

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请勿使用指示器。

MaterialIcon

方法

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

方法

方法返回类型简介
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设置要打开的网址。

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_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开关 widget 的切换开关样式控件。
CHECK_BOXEnum开关微件的复选框样式控件。

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

属性

属性类型说明
OUTLINEDEnum带有清晰背景的普通文本按钮。
TEXTEnum请勿使用。
FILLEDEnum带有彩色背景的文本按钮。
FILLED_TONALEnum介于填充型按钮和轮廓型按钮之间的一种替代方案:普通文本按钮。
BORDERLESSEnum无边框的普通文本按钮。

TextInput

方法

方法返回类型简介
setFieldName(fieldName)TextInput在发生界面互动时生成的事件对象中设置用于标识此文本输入的键。
setHint(hint)TextInput为文本输入设置提示。
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设置在微件中显示的文本行数上限。
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构建当前通用 Action 响应并对其进行验证。
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添加了可供选择的新项。

Validation

方法

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

VerticalAlignment

属性

属性类型说明
CENTEREnum将内容垂直放置在容器的中心。
TOPEnum将内容垂直放置在容器顶部。
BOTTOMEnum将内容垂直放置在容器底部。

Widget

WrapStyle

属性

属性类型说明
NOWRAPEnum不换行。
WRAPEnum为列中的任何 widget 换行内容。