AddOns Response Service

添加插件响应服务

此服务允许脚本配置和构建 Google Workspace 插件。

类

名称	简介
AccessoryWidget	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
Action	Google Workspace 插件（用于扩展 Google Workspace Studio）可使用此操作来呈现新卡片。
ActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
AddOnsResponseService	AddOnsResponseService 提供了为 Google Workspace 加载项创建响应的功能。
AddonComposeUiActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
AddonComposeUiActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
AddonComposeUiActionType	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
Attachment	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
BasicDataType	表示基本泛型数据类型的枚举。
CalendarEventActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
CalendarEventActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ChatDataActionsResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ChatMessage	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
Color	一个 Color 对象，表示 RGBA 颜色空间中的一种颜色。
ComposeActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ComposeActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ComposedEmailType	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ContentType	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
CreateMessageAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
DataActionsResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
DataType	DataType 用于设置变量的类型。
DriveItemsSelectedActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
DriveItemsSelectedActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
DynamicResourceDefinition	DynamicResourceDefinition 是 ResourceFieldsDefinitionRetrievedAction 的构建块，它可以包含一个或多个 ResourceField，用于动态定义 Google Workspace Studio 中某个步骤提供的输出变量数量。
EditorFileScopeActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
EditorFileScopeActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
EndNavigation	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ErrorActionability	表示错误可操作性的枚举。
ErrorRetryability	一个枚举，用于表示在出现错误时操作调用的可重试性。
FontWeight	表示带样式的文本的字重的枚举。
HostAppAction	HostAppAction 是一种由各个宿主应用处理的 Action。
Hyperlink	在 TextFormatElement 中使用的 Hyperlink 元素。
InsertSection	用于构建 InsertSection 对象的构建器。
InsertWidget	用于构建 InsertWidget 对象的构建器。
Link	来自第三方资源的链接对象，该对象在宿主应用中转换为智能条状标签。
LinkPreview	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
ListContainer	列表项的容器，其中每个列表项可以包含多个 TextFormatElement。
ListItem	一个列表项，其中每个列表项可以包含多个 TextFormatElement。
ListType	表示列表类型的枚举。
ModifyCard	用于构建 ModifyCard 对象的构建器，该对象通过将 ModifyCard 对象传递给 Action 来更改和更新现有卡的界面。
Navigation	用于控制卡片导航的辅助对象。
Notification	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
OnClose	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
OpenAs	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
OpenLink	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
RemoveSection	RemoveSection 对象的构建器。
RemoveWidget	RemoveWidget 对象的构建器。
RenderAction	通过执行 Action 来响应用户互动，从而渲染或更新卡片。
RenderActionBuilder	RenderAction 对象的构建器。
ResourceData	表示应用特定的资源数据，资源数据包含变量名称和 VariableData 的键值对集合。
ResourceField	ResourceField 是 DynamicResourceDefinition 的基本构建块，每个资源字段都对应于当前步骤的输出变量。
ResourceFieldsDefinitionRetrievedAction	ResourceFieldsDefinitionRetrievedAction 是一种 ResourceFieldsDefinitionRetrievedAction，用于通过清单中指定的 dynamicResourceDefinitionProvider 函数检索资源字段列表的定义。
ResourceRetrievedAction	ResourceRetrievedAction 用于在需要时检索自定义资源内容，其中自定义资源字段在 ResourceData 中定义。
ResourceType	一种特定于应用的资源类型，该资源类型的唯一标识符应具有相应的 WorkflowResourceDefinition。
ReturnElementErrorAction	ReturnElementErrorAction 表示在元素调用期间发生了错误。
ReturnOutputVariablesAction	包含 Google Workspace Studio 中执行的操作生成的输出变量。
SaveWorkflowAction	此操作表示宿主应用 (Google Workspace Studio) 应保存代理。
SendStatus	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
StyledText	具有粗体、斜体和颜色等样式的文本元素。
TextFormatChip	文本格式的可点击 chip。
TextFormatElement	文本格式元素，可以是 TextFormatChip、StyledText、Hyperlink 或 ListContainer。
TextFormatIcon	显示在 TextFormatChip 中的图标。
TextStyle	表示带样式的文本的样式的枚举。
TimeStamp	表示可添加到 VariableData 的时间戳对象。
UniversalActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UniversalActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftActionResponse	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftActionResponseBuilder	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftBccRecipientsAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftBodyAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftBodyType	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftCcRecipientsAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftSubjectAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateDraftToRecipientsAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateInlinePreviewAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateMessageAction	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
UpdateWidget	UpdateWidget 对象的构建器。
ValidationErrorSeverity	表示验证错误严重程度的枚举。
ValueMetadata	valueMetadata 包含有关变量潜在值的信息。
VariableData	表示一种可变数据，可以包含各种类型的值的集合。
WorkflowAction	WorkflowAction 是一种 HostAppAction，用于在 Google Workspace Studio 中执行特定操作。
WorkflowTextFormat	一个文本块，包含在 TextFormatElement 中定义的富格式设置选项，包括样式、超链接和互动元素。
WorkflowValidationErrorAction	此操作表示宿主应用 (Google Workspace Studio) 应显示验证错误。

AccessoryWidget

方法

方法	返回类型	简介
addWidget(widget)	AccessoryWidget	为此操作设置 widget。

Action

方法

方法	返回类型	简介
addModifyCard(modifyCard)	Action	向操作添加 ModifyCard 操作。
addNavigation(navigation)	Action	向操作添加卡片导航。

ActionResponse

方法

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

ActionResponseBuilder

方法

方法	返回类型	简介
addModifyCard(modifyCard)	ActionResponseBuilder	将修改卡片操作设置为相应操作。
build()	ActionResponse	构建当前操作响应并对其进行验证。
setLinkPreview(linkPreview)	ActionResponseBuilder	将 LinkPreview 设置为操作。
setNavigation(navigation)	ActionResponseBuilder	将响应设置为 Navigation 操作。
setNotification(notification)	ActionResponseBuilder	设置在操作激活时显示的通知。
setOpenLink(openLink)	ActionResponseBuilder	设置在激活操作时要前往的网址。
setStateChanged(stateChanged)	ActionResponseBuilder	设置一个标志，以指示相应操作更改了现有数据状态。

AddOnsResponseService

属性

属性	类型	说明
AddonComposeUiActionType	AddonComposeUiActionType	AddonComposeUiActionType 枚举。
ComposedEmailType	ComposedEmailType	ComposedEmailType 枚举。
ContentType	ContentType	ContentType 枚举。
EndNavigation	EndNavigation	EndNavigation 枚举。
OnClose	OnClose	OnClose 枚举。
OpenAs	OpenAs	OpenAs 枚举。
SendStatus	SendStatus	SendStatus 枚举。
UpdateDraftBodyType	UpdateDraftBodyType	UpdateDraftBodyType 枚举。

方法

方法	返回类型	简介
newAccessoryWidget()	AccessoryWidget	创建新的 AccessoryWidget。
newAction()	Action	创建新的 Action。
newActionResponseBuilder()	ActionResponseBuilder	创建 ActionResponseBuilder。
newAddonComposeUiActionResponseBuilder()	AddonComposeUiActionResponseBuilder	创建 AddonComposeUiActionResponseBuilder。
newAttachment()	Attachment	创建 Attachment。
newCalendarEventActionResponseBuilder()	CalendarEventActionResponseBuilder	创建 CalendarEventActionResponseBuilder。
newChatDataActionBuilder()	ChatDataActionsResponseBuilder	创建 ChatDataActionsResponseBuilder。
newChatMessage()	ChatMessage	创建 ChatMessage。
newComposeActionResponseBuilder()	ComposeActionResponseBuilder	创建 ComposeActionResponseBuilder。
newCreateMessageAction()	CreateMessageAction	创建 CreateMessageAction。
newDriveItemsSelectedActionResponseBuilder()	DriveItemsSelectedActionResponseBuilder	创建 DriveItemsSelectedActionResponseBuilder。
newEditorFileScopeActionResponseBuilder()	EditorFileScopeActionResponseBuilder	创建 EditorFileScopeActionResponseBuilder。
newLinkPreview()	LinkPreview	创建 LinkPreview。
newNavigation()	Navigation	创建 Navigation。
newNotification()	Notification	创建 Notification。
newOpenLink()	OpenLink	创建 OpenLink。
newRenderActionBuilder()	RenderActionBuilder	创建新的 RenderActionBuilder。
newUniversalActionResponseBuilder()	UniversalActionResponseBuilder	创建 UniversalActionResponseBuilder。
newUpdateDraftActionResponseBuilder()	UpdateDraftActionResponseBuilder	创建 UpdateDraftActionResponseBuilder。
newUpdateDraftBccRecipientsAction()	UpdateDraftBccRecipientsAction	创建 UpdateDraftBccRecipientsAction；
newUpdateDraftBodyAction()	UpdateDraftBodyAction	创建 UpdateDraftBodyAction。
newUpdateDraftCcRecipientsAction()	UpdateDraftCcRecipientsAction	创建 UpdateDraftCcRecipientsAction。
newUpdateDraftSubjectAction()	UpdateDraftSubjectAction	创建 UpdateDraftSubjectAction。
newUpdateDraftToRecipientsAction()	UpdateDraftToRecipientsAction	创建 UpdateDraftToRecipientsAction。
newUpdateInlinePreviewAction()	UpdateInlinePreviewAction	创建 UpdateInlinePreviewAction。
newUpdateMessageAction()	UpdateMessageAction	创建 UpdateMessageAction。

AddonComposeUiActionResponse

方法

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

AddonComposeUiActionResponseBuilder

方法

方法	返回类型	简介
build()	AddonComposeUiActionResponse	构建当前插件的撰写界面操作响应并对其进行验证。
setType(type)	AddonComposeUiActionResponseBuilder	设置用于确定插件撰写界面操作的枚举字段。

AddonComposeUiActionType

属性

属性	类型	说明
DISMISS	Enum	默认。

Attachment

方法

方法	返回类型	简介
setIconUrl(iconUrl)	Attachment	设置附件的图标网址。
setMimeType(mimeType)	Attachment	设置附件的 MIME 类型。
setResourceUrl(resourceUrl)	Attachment	为附件设置资源网址。
setTitle(title)	Attachment	为附件设置标题。

BasicDataType

属性

属性	类型	说明
BASIC_TYPE_UNSPECIFIED	Enum	默认值。
STRING	Enum	一个字符串。
INTEGER	Enum	一个整数值。
FLOAT	Enum	浮点数。
TIMESTAMP	Enum	采用 ISO 8601 格式的时间戳。
BOOLEAN	Enum	布尔值。
EMAIL_ADDRESS	Enum	格式为电子邮件地址的字符串。
GOOGLE_USER	Enum	Google 服务用户，格式为“users/encoded_GAIA_ID”
FILE	Enum	文件类型。
FORMATTED_TEXT	Enum	具有丰富格式的文本。

CalendarEventActionResponse

方法

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

CalendarEventActionResponseBuilder

方法

方法	返回类型	简介
addAttachments(attachments)	CalendarEventActionResponseBuilder	指定当执行关联的界面操作时，响应应将附件添加到日历活动中。
addAttendees(emails)	CalendarEventActionResponseBuilder	指定当执行关联的界面操作时，响应应将指示的参加者添加到日历活动中。
build()	CalendarEventActionResponse	构建当前日历活动操作响应并对其进行验证。
setConferenceData(conferenceData)	CalendarEventActionResponseBuilder	指定当执行关联的界面操作时，响应应将指示的会议数据设置为日历活动。

ChatDataActionsResponseBuilder

方法

方法	返回类型	简介
build()	DataActionsResponse	构建当前操作响应。
setCreateChatMessageAction(createMessageAction)	ChatDataActionsResponseBuilder	为相应 DataActionsResponse 设置 CreateMessageAction。
setUpdateChatMessageAction(updateMessageAction)	ChatDataActionsResponseBuilder	为相应 DataActionsResponse 设置 UpdateMessageAction。
setUpdateInlinePreviewAction(updateInlinePreviewAction)	ChatDataActionsResponseBuilder	为相应 DataActionsResponse 设置 UpdateInlinePreviewAction。

ChatMessage

方法

方法	返回类型	简介
addCardWithId(cardWithId)	ChatMessage	设置消息的卡片。
setText(text)	ChatMessage	设置消息的文本。

Color

方法

方法	返回类型	简介
setAlpha(alpha)	Color	设置颜色的 Alpha 分量。
setBlue(blue)	Color	设置颜色的蓝色分量。
setGreen(green)	Color	设置颜色的绿色分量。
setRed(red)	Color	设置颜色的红色分量。

ComposeActionResponse

方法

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

ComposeActionResponseBuilder

方法

方法	返回类型	简介
build()	ComposeActionResponse	构建当前撰写操作响应并对其进行验证。
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，但生成后无法修改。

CreateMessageAction

方法

方法	返回类型	简介
setMessage(message)	CreateMessageAction	为此操作设置消息。

DataActionsResponse

方法

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

DataType

方法

方法	返回类型	简介
setBasicDataType(basicDataType)	DataType	将数据类型设置为支持的 BasicDataType 之一。
setResourceType(resourceType)	DataType	将数据类型设置为自定义的 ResourceType。
setValueMetadata(valueMetadata)	DataType	设置 ValueMetadata，其中包含与变量相关的类型信息。

DriveItemsSelectedActionResponse

方法

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

DriveItemsSelectedActionResponseBuilder

方法

方法	返回类型	简介
build()	DriveItemsSelectedActionResponse	构建当前的 Google 云端硬盘操作响应。
requestFileScope(itemId)	DriveItemsSelectedActionResponseBuilder	指定响应请求云端硬盘中与上下文相关联的项目的文件范围。

DynamicResourceDefinition

方法

方法	返回类型	简介
addResourceField(resourceField)	DynamicResourceDefinition	向动态资源定义添加资源字段。
setResourceId(resourceId)	DynamicResourceDefinition	设置动态资源定义的 ID，此 ID 对应于清单中的 workflowResourceDefinitionId。

EditorFileScopeActionResponse

方法

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

EditorFileScopeActionResponseBuilder

方法

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

EndNavigation

属性

属性	类型	说明
ACTION_UNSPECIFIED	Enum	未指定操作。
CLOSE_DIALOG	Enum	关闭对话框。
CLOSE_DIALOG_AND_EXECUTE	Enum	关闭对话框并刷新打开该对话框的卡片。

ErrorActionability

属性

属性	类型	说明
ERROR_ACTIONABILITY_UNSPECIFIED	Enum	未指定。
NOT_ACTIONABLE	Enum	用户无法通过配置卡片修复此错误。
ACTIONABLE	Enum	用户可以通过配置卡片修正此错误。

ErrorRetryability

属性

属性	类型	说明
RETRYABILITY_UNSPECIFIED	Enum	未指定。
NOT_RETRYABLE	Enum	该错误无法重试，流程会在第一次尝试后终止。
RETRYABLE	Enum	此错误可重试，工作流将尝试执行相应步骤最多 5 次。

FontWeight

属性

属性	类型	说明
FONT_WEIGHT_UNSPECIFIED	Enum	标准粗细的标准重量。
LIGHT	Enum	重量更轻，厚度更薄。
MEDIUM	Enum	介于浅色和粗体之间的中间粗细。
BOLD	Enum	重量更重，厚度更大。

HostAppAction

方法

方法	返回类型	简介
setWorkflowAction(workflowAction)	HostAppAction	将宿主应用操作设置为工作流操作。

Hyperlink

方法

方法	返回类型	简介
setLink(link)	Hyperlink	设置超链接的目标网址。
setText(text)	Hyperlink	设置超链接的文本。

InsertSection

方法

方法	返回类型	简介
insertAtTop(onCardTop)	InsertSection	设置 onCardTop 标志，用于指示是否应将新部分插入到卡片的顶部。
insertBelowSection(sectionId)	InsertSection	设置版块 ID，新版块将插入到该 ID 下方。
setSection(section)	InsertSection	设置要插入的卡片部分。

InsertWidget

方法

方法	返回类型	简介
insertAboveWidget(widgetId)	InsertWidget	设置 widget ID，并将新 widget 插入到具有指定 ID 的 widget 上方。
insertBelowWidget(widgetId)	InsertWidget	设置 widget ID，并将新 widget 插入到具有指定 ID 的 widget 下方。
setWidget(widget)	InsertWidget	设置要插入的 Widget。

Link

方法

方法	返回类型	简介
setTitle(title)	Link	设置链接的标题。
setUrl(url)	Link	设置链接的网址。

LinkPreview

方法

方法	返回类型	简介
printJson()	String	输出此对象的 JSON 表示形式。
setLinkPreviewTitle(title)	LinkPreview	设置链接预览中显示在预览卡片上方的标题。
setPreviewCard(previewCard)	LinkPreview	设置显示来自第三方或非 Google 服务的链接相关信息的卡片。
setTitle(title)	LinkPreview	设置链接预览的智能条状标签中显示的标题。

ListContainer

方法

方法	返回类型	简介
addListItem(listItem)	ListContainer	向列表容器添加列表项。
setListNestLevel(listLevel)	ListContainer	设置列表的级别，从顶级列表的 0 开始，每嵌套一个列表就增加 1。
setListType(listType)	ListContainer	将列表的类型设置为有序或无序。

ListItem

方法

方法	返回类型	简介
addTextFormatElement(textFormatElement)	ListItem	向列表项添加 TextFormatElement。

ListType

属性

属性	类型	说明
LIST_TYPE_UNSPECIFIED	Enum	默认值。
ORDERED	Enum	有序列表。
UNORDERED	Enum	无序列表。

ModifyCard

方法

方法	返回类型	简介
setInsertSection(insertSection)	ModifyCard	为此修改卡片对象设置 InsertSection。
setInsertWidget(insertWidget)	ModifyCard	为此修改卡片对象设置 InsertWidget。
setRemoveSection(removeSection)	ModifyCard	为此修改卡片对象设置 RemoveSection。
setRemoveWidget(removeWidget)	ModifyCard	为此修改卡片对象设置 RemoveWidget。
setReplaceSection(replacementSection)	ModifyCard	为此修改卡片对象设置替换 CardSection，替换部分应具有与现有卡片部分相同的 ID。
setReplaceWidget(replacementWidget)	ModifyCard	为此修改卡片对象设置替换微件，替换微件应具有与现有微件相同的 ID。
setUpdateWidget(updateWidget)	ModifyCard	为此修改卡片对象设置 UpdateWidget。

Navigation

方法

方法	返回类型	简介
popCard()	Navigation	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
popToNamedCard(cardName)	Navigation	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
popToRoot()	Navigation	开发者预览版：作为 Google Workspace 开发者预览版计划的一部分提供，让您能够抢先体验某些功能。
printJson()	String	输出此对象的 JSON 表示形式。
pushCard(card)	Navigation	将给定的卡片推送到堆栈。
setEndNavigation(endNavigation)	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	设置要打开的网址。

RemoveSection

方法

方法	返回类型	简介
setSectionId(sectionId)	RemoveSection	设置要移除的部分的部分 ID。

RemoveWidget

方法

方法	返回类型	简介
setWidgetId(widgetId)	RemoveWidget	设置要移除的 widget 的 widget ID。

RenderAction

方法

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

RenderActionBuilder

方法

方法	返回类型	简介
build()	RenderAction	构建当前渲染操作并对其进行验证。
setAction(action)	RenderActionBuilder	将插件可用于更新界面的操作设置为渲染操作。
setHostAppAction(hostAppAction)	RenderActionBuilder	将各个宿主应用处理的 HostAppAction 设置为渲染操作。

ResourceData

方法

方法	返回类型	简介
addVariableData(key, value)	ResourceData	添加一个以变量名称为键的 VariableData，如果键已存在，则覆盖相应的值。
setVariableDataMap(fields)	ResourceData	设置由变量名称键控的变量数据映射。

ResourceField

方法

方法	返回类型	简介
setDataType(dataType)	ResourceField	设置字段的数据类型，允许其他步骤在选择时按类型过滤变量。
setDisplayText(displayText)	ResourceField	设置在后续步骤中选择变量期间向最终用户显示的字段说明。
setSelector(selector)	ResourceField	为提供方函数设置一个键，以便在执行相应步骤期间提供值。

ResourceFieldsDefinitionRetrievedAction

方法

方法	返回类型	简介
addDynamicResourceDefinition(dynamicResourceDefinition)	ResourceFieldsDefinitionRetrievedAction	向检索到的资源字段定义操作添加了 DynamicResourceDefinition。

ResourceRetrievedAction

方法

方法	返回类型	简介
setResourceData(resourceData)	ResourceRetrievedAction	将 ResourceData 设置为检索到的资源操作，以向动态资源字段或自定义资源字段提供值。

ResourceType

方法

方法	返回类型	简介
setWorkflowResourceDefinitionId(resourceType)	ResourceType	设置工作流资源定义 ID。

ReturnElementErrorAction

方法

方法	返回类型	简介
setErrorActionability(errorActionability)	ReturnElementErrorAction	设置错误的可操作性，如果可以通过重新配置步骤来解决错误，则该错误应该是可操作的。
setErrorLog(log)	ReturnElementErrorAction	设置要在工作流的活动 Feed 中向最终用户显示错误日志。
setErrorRetryability(errorRetryability)	ReturnElementErrorAction	设置错误重试能力，如果错误不可重试，则流程在第一次尝试后终止。

ReturnOutputVariablesAction

方法

方法	返回类型	简介
addVariableData(key, value)	ReturnOutputVariablesAction	添加以变量名称为键的变量数据，如果键已存在，则覆盖相应的值。
setLog(log)	ReturnOutputVariablesAction	将已执行的工作流操作的日志设置到工作流的活动 Feed 中，供最终用户查看。
setVariableDataMap(variables)	ReturnOutputVariablesAction	设置以变量名称为键的变量数据映射，如果键已存在，则覆盖相应的值。

SaveWorkflowAction

SendStatus

属性

属性	类型	说明
NOT_SEND	Enum	默认。
CONTINUE_SEND	Enum	更新草稿后继续发送电子邮件。

StyledText

方法

方法	返回类型	简介
addStyle(style)	StyledText	设置带样式的文本的样式，可将多种样式应用于单个带样式的文本。
setColor(color)	StyledText	设置样式化文本的颜色。
setFontWeight(fontWeight)	StyledText	设置样式化文本的字重。
setText(text)	StyledText	设置带样式的文本的主要内容。

TextFormatChip

方法

方法	返回类型	简介
setLabel(label)	TextFormatChip	设置在条状标签中显示的文本。
setTextFormatIcon(icon)	TextFormatChip	设置条状标签中显示的图标。
setUrl(url)	TextFormatChip	设置点击条状标签后要前往的网址。

TextFormatElement

方法

方法	返回类型	简介
setHyperlink(hyperlink)	TextFormatElement	将文本格式元素设置为 Hyperlink。
setListContainer(listContainer)	TextFormatElement	将文本格式元素设置为 ListContainer。
setStyledText(styledText)	TextFormatElement	将文本格式元素设置为 StyledText。
setText(text)	TextFormatElement	将文本格式元素设置为文本字符串。
setTextFormatChip(chip)	TextFormatElement	将文本格式元素设置为 TextFormatChip。

TextFormatIcon

方法

方法	返回类型	简介
setIconUrl(iconUrl)	TextFormatIcon	设置图标网址。
setMaterialIconName(materialIconName)	TextFormatIcon	设置 Google Material 图标中定义的 Material 图标名称。

TextStyle

属性

属性	类型	说明
STYLE_UNSPECIFIED	Enum	未应用任何样式。
ITALIC	Enum	斜体样式。
UNDERLINE	Enum	下划线样式。
STRIKETHROUGH	Enum	删除线样式。
LINE_BREAK	Enum	换行符。
UPPERCASE	Enum	大写样式。
CODE	Enum	代码样式。
CODE_BLOCK	Enum	代码块样式。

TimeStamp

方法

方法	返回类型	简介
setNanos(nanos)	TimeStamp	设置时间戳的纳秒数，表示当前秒内的纳秒数。
setSeconds(seconds)	TimeStamp	设置时间戳的秒数，表示自 Unix 纪元（1970 年 1 月 1 日 00:00:00 UTC）以来的秒数。

UniversalActionResponse

方法

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

UniversalActionResponseBuilder

方法

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

UpdateDraftActionResponse

方法

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

UpdateDraftActionResponseBuilder

方法

方法	返回类型	简介
build()	UpdateDraftActionResponse	构建当前更新草稿操作响应并对其进行验证。
setSendStatus(sendStatus)	UpdateDraftActionResponseBuilder	设置枚举字段，该字段用于确定是否在更新操作后发送电子邮件。
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	更新电子邮件草稿的“收件人”字段。

UpdateInlinePreviewAction

方法

方法	返回类型	简介
addCardWithId(cardWithId)	UpdateInlinePreviewAction	为相应操作添加卡片。
addExpiration(ttl)	UpdateInlinePreviewAction	为此操作添加过期时间。

UpdateMessageAction

方法

方法	返回类型	简介
setMessage(message)	UpdateMessageAction	为此操作设置消息。

UpdateWidget

方法

方法	返回类型	简介
addSuggestion(text, value, selected, startIconUri, bottomText)	UpdateWidget	为多选菜单添加可供选择的新项。

ValidationErrorSeverity

属性

属性	类型	说明
SEVERITY_UNSPECIFIED	Enum	未指定。
CRITICAL	Enum	严重，此错误非常严重，必须先修正，然后才能发布。
WARNING	Enum	警告：此错误不严重，不会阻止发布。

ValueMetadata

方法

方法	返回类型	简介
addCastableType(dataType)	ValueMetadata	向此值元数据添加了可选的允许类型，这些类型可以动态转换为变量数据。
addEnumValue(enumValue)	ValueMetadata	向变量的允许枚举值添加一个可选的字符串值，只有在 DataType 设置为 String 类型时，才能设置此字段。
setDefaultValue(defaultValue)	ValueMetadata	设置变量的可选默认值，例如，如果变量类型为布尔值，则 defaultValue 可设置为“true”或“false”。

VariableData

方法

方法	返回类型	简介
addBooleanValue(value)	VariableData	向变量数据添加布尔值。
addEmailAddress(emailAddress)	VariableData	向变量数据添加电子邮件地址。
addFloatValue(value)	VariableData	向变量数据添加浮点值。
addGoogleUser(googleUser)	VariableData	将 Google 用户添加到变量数据。
addIntegerValue(value)	VariableData	向变量数据添加一个整数值。
addResourceData(resourceData)	VariableData	向变量数据添加 ResourceData 值。
addResourceReference(resourceReference)	VariableData	向变量数据添加资源引用 ID。
addStringValue(value)	VariableData	向变量数据添加字符串值。
addTimestampValue(value)	VariableData	向变量数据添加 TimeStamp 值。
addWorkflowTextFormat(workflowTextFormat)	VariableData	向变量数据添加 WorkflowTextFormat 值。

WorkflowAction

WorkflowTextFormat

方法

方法	返回类型	简介
addTextFormatElement(textFormatElement)	WorkflowTextFormat	向工作流文本格式添加了 TextFormatElement。

WorkflowValidationErrorAction

方法

方法	返回类型	简介
setSeverity(severity)	WorkflowValidationErrorAction	设置验证错误的严重程度。