Package apps.extensions.markup

索引

• CalendarClientActionMarkup（消息）
• CalendarClientActionMarkup.AddAttachmentsActionMarkup（消息）
• CalendarClientActionMarkup.AddAttachmentsActionMarkup.AddonAttachment（消息）
• CalendarClientActionMarkup.ConferenceDataMarkup（消息）
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup（消息）
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Feature（枚举）
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Type（枚举）
• CalendarClientActionMarkup.ConferenceDataMarkup.Error（消息）
• CalendarClientActionMarkup.ConferenceDataMarkup.Error.Type（枚举）
• CalendarClientActionMarkup.ConferenceDataMarkup.Parameter（消息）
• CalendarClientActionMarkup.EditAttendeesActionMarkup（消息）
• CalendarClientActionMarkup.EditConferenceDataActionMarkup（消息）
• ChatClientDataSourceMarkup（消息）
• ChatClientDataSourceMarkup.SpaceDataSource（消息）
• ChatDataActionMarkup（消息）
• ChatDataActionMarkup.CreateMessageAction（消息）
• ChatDataActionMarkup.UpdateInlinePreviewAction（消息）
• ChatDataActionMarkup.UpdateMessageAction（消息）
• DriveClientActionMarkup（消息）
• DriveClientActionMarkup.RequestFileScope（消息）
• EditorClientActionMarkup（消息）
• EditorClientActionMarkup.RequestFileScopeForActiveDocument（消息）
• GmailClientActionMarkup（消息）
• GmailClientActionMarkup.AddonComposeUiActionMarkup（消息）
• GmailClientActionMarkup.AddonComposeUiActionMarkup.AddonComposeUiActionType（枚举）
• GmailClientActionMarkup.OpenCreatedDraftActionMarkup（消息）
• GmailClientActionMarkup.TaskActionMarkup（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.Recipient（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBccRecipients（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.ContentType（枚举）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.EmailMimeType（枚举）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.InsertContent（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.Type（枚举）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateCcRecipients（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateSubject（消息）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateToRecipients（消息）
• HostAppActionMarkup（消息）
• HostAppDataActionMarkup（消息）
• HostAppDataSourceMarkup（消息）
• SheetsClientActionMarkup（消息）
• SheetsClientActionMarkup.CustomFunctionReturnValueMarkup（消息）

CalendarClientActionMarkup

字段
editAttendeesActionMarkup	EditAttendeesActionMarkup 用于向 Google 日历活动添加参加者的操作。
editConferenceDataActionMarkup	EditConferenceDataActionMarkup 用于向 Google 日历活动添加会议数据的操作。第三方会议插件只能在 Apps Script 中构建。
addAttachmentsActionMarkup	AddAttachmentsActionMarkup 用于向 Google 日历活动添加附件的操作。

AddAttachmentsActionMarkup

字段
addonAttachments[]	AddonAttachment

AddonAttachment

字段
resourceUrl	string
title	string 附件的标题。
mimeType	string resourceUrl 中内容的 MIME 类型。
iconUrl	string 指向资源图标的链接。

ConferenceDataMarkup

用于定义与 Google 日历活动关联的会议数据的标记。第三方会议插件只能在 Apps Script 中构建。

字段
conferenceId	string 此会议数据的唯一标识符。长度不得超过 512 个字符。
entryPoints[]	EntryPointMarkup 会议的入口点。最多允许 300 个入口点。
parameters[]	Parameter 其他插件参数。最多允许 300 个参数。
error	Error 如果已设置，则表示在创建会议期间发生了错误。
note	string 要向用户显示的其他备注（例如管理员的说明、法律通知）。可以包含 HTML。长度上限为 2048 个字符。
conferenceSolutionId	string 会议解决方案的标识符。必须与部署的 calendar.conferenceSolution.id 字段中的值匹配。

EntryPointMarkup

加入会议的方式。第三方会议插件只能在 Apps Script 中构建。

字段
type	Type 入口点的类型。必填。
uri	string 用于加入会议的 URI。支持 tel: 和 http(s):，长度不得超过 1300 个字符。必填。
label	string 要向用户显示的入口点的标签。长度不得超过 512 个字符。
meetingCode	string 用于访问会议的会议代码。长度不得超过 128 个字符。
accessCode	string 用于访问大会的访问码。长度不得超过 128 个字符。
passcode	string 用于访问大会的密码。长度不得超过 128 个字符。
password	string 用于访问会议的密码。长度不得超过 128 个字符。
pin	string 用于访问会议的 PIN 码。长度不得超过 128 个字符。
regionCode	string 与此入口点关联的国家/地区的 CLDR/ISO 3166 地区代码。仅适用于 Type.PHONE。
features[]	Feature 入口点的特点，例如是否收费。一个入口点可以包含多个功能。

功能

入口点的功能。某些功能可能仅适用于特定入口点。

枚举
UNKNOWN_FEATURE	未知地图项。
TOLL	适用于 PHONE 入口点。拨打付费电话的费用由主叫方承担。一个号码不能同时是付费号码和免费号码。
TOLL_FREE	适用于 PHONE 入口点。致电免费电话号码对致电方来说是免费的。一个号码不能同时是付费号码和免费号码。

类型

入口点的类型。第三方会议插件只能在 Apps Script 中构建。

枚举
UNKNOWN	会议类型未知。
VIDEO	视频会议。
PHONE	电话会议。
MORE	用于提供指向进一步会议加入信息的链接。
SIP	使用会话发起协议的会议

错误

表示在创建会议期间发生的错误。第三方会议插件只能在 Apps Script 中构建。

字段
type	Type 错误类型。必填。
authenticationUrl	string 如果错误类型为 AUTHENTICATION，该插件可以提供一个网址，以便用户登录。长度不得超过 1300 个字符。

类型

枚举
UNKNOWN	未知错误。
AUTHENTICATION	身份验证错误。
TEMPORARY	临时错误。
PERMANENT	永久性错误。
PERMISSION_DENIED	用户无权在第三方会议系统中执行某些操作。
CONFERENCE_SOLUTION_FORBIDDEN	用户无法使用所选的会议解决方案（但可能可以使用该插件提供的其他解决方案）。

参数

与事件数据一起保留的特定于解决方案的参数，如果需要更新或删除，则会传递给插件。例如：[{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

字段
key	string 参数的键。长度不得超过 50 个字符。必填。
value	string 参数值。长度不得超过 1024 个字符。必填。

EditAttendeesActionMarkup

字段
addAttendeeEmails[]	string 要添加到 Google 日历活动中的参加者列表。

EditConferenceDataActionMarkup

字段
联合字段 conference。 conference 只能是下列其中一项：
conferenceData	ConferenceDataMarkup 要添加到 Google 日历活动中的会议数据。第三方会议插件只能在 Apps Script 中构建。

ChatClientDataSourceMarkup

对于使用多选菜单的 SelectionInput 微件，请使用 Google Chat 中的数据源。数据源会为多选菜单填充选择项。例如，用户可以选择自己是成员的 Google Chat 聊天室。

适用于 Google Chat 应用，不适用于 Google Workspace 插件。

字段
联合字段 source。Google Chat 数据源。source 只能是下列其中一项：
spaceDataSource	SpaceDataSource 用户所属的 Google Chat 聊天室。

SpaceDataSource

一种数据源，用于将 Google Chat 聊天室填充为多选菜单的选择项。仅填充用户是成员的聊天室。

适用于 Google Chat 应用，不适用于 Google Workspace 插件。

字段
defaultToCurrentSpace	bool 如果设置为 true，多选菜单会默认选择当前的 Google Chat 聊天室作为项。

ChatDataActionMarkup

在 Google Chat 中创建或更新消息。有关详情，请参阅构建 Google Chat 界面。

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

字段
联合字段 action。Google Chat 操作。action 只能是下列其中一项：
createMessageAction	CreateMessageAction 以 Google Chat 扩展应用的身份发送消息。
updateMessageAction	UpdateMessageAction 更新 Google Chat 应用的消息。
updateInlinePreviewAction	UpdateInlinePreviewAction 如需预览链接，请向 Google Chat 用户的消息添加一张或多张卡片。

CreateMessageAction

Chat 应用发送消息。有关详情，请参阅发送 Google Chat 消息。

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

字段
message	Message Google Chat 消息。

UpdateInlinePreviewAction

Chat 应用会通过添加或更新一张或多张卡片来预览消息中的链接。如需了解详情，请参阅预览 Google Chat 消息中的链接。

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

字段
cardsV2[]	CardWithId 一个或多个卡片的数组。

UpdateMessageAction

Chat 应用会更新消息中的文本或卡片。有关详情，请参阅发送 Google Chat 消息。

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

字段
message	Message 更新后的消息。

DriveClientActionMarkup

字段
requestFileScope	RequestFileScope

RequestFileScope

字段
itemId	string

EditorClientActionMarkup

字段
联合字段 action。 action 只能是下列其中一项：
requestFileScopeForActiveDocument	RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

此类型没有字段。

GmailClientActionMarkup

字段
联合字段 type。 type 只能是下列其中一项：
taskAction	TaskActionMarkup
updateDraftActionMarkup	UpdateDraftActionMarkup
openCreatedDraftActionMarkup	OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup	AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

字段
type	AddonComposeUiActionType

AddonComposeUiActionType

枚举
UNSPECIFIED	默认。如果未指定，则不采取任何措施。
DISMISS	关闭插件 Compose 界面。

OpenCreatedDraftActionMarkup

字段
draftId	string 新创建的草稿的 ID，格式为“r123”。
draftStorageId	string 服务器存储空间 ID（十六进制格式），例如“15e9fa622ce1029d”。
draftThreadServerPermId	string 草稿会话的服务器永久 ID。此字段未在任何位置设置，并且在处理 OpenCreatedDraftActionMarkup 时会被忽略。请改为提供和使用 draftThreadStorageId。
draftThreadId	string 包含新创建的草稿的会话的 ID，例如“15e9fa622ce1029d”。

TaskActionMarkup

字段
reloadTasks	bool

UpdateDraftActionMarkup

字段
updateBody	UpdateBody 一个字段，用于包含对用户当前正在修改的草稿正文执行的一系列更新操作。
updateToRecipients	UpdateToRecipients 如果设置，则会替换用户当前正在修改的草稿的“收件人”部分中现有的收件人。
updateCcRecipients	UpdateCcRecipients 如果设置，则会替换用户当前正在修改的草稿的现有抄送收件人。
updateBccRecipients	UpdateBccRecipients 如果设置，则会替换用户当前正在修改的草稿的现有密送收件人。
updateSubject	UpdateSubject 如果设置，则会替换用户当前正在修改的草稿的现有主题。

收件人

字段
email	string

UpdateBccRecipients

字段
bccRecipients[]	Recipient

UpdateBody

字段
insertContents[]	InsertContent 一个重复字段，其中包含要插入用户当前正在修改的草稿中的一系列内容。内容可以包含 HTML 内容或纯文本内容。
type	Type

ContentType

枚举
UNSPECIFIED_CONTENT_TYPE	未为 ContentType 设置任何值时的默认值。
TEXT	指定内容为纯文本。
MUTABLE_HTML	指定内容采用 HTML 格式且可变（可修改）。
IMMUTABLE_HTML	指定内容为 HTML 格式且不可变（无法修改）。

EmailMimeType

EmailMimeType 已废弃。请使用 ContentType。

枚举
UNSPECIFIED_EMAIL_MIME_TYPE	未为 EmailMimeType 设置任何值时的默认值。
PLAIN_TEXT	指定插入的内容为纯文本。
HTML	指定插入的内容采用 HTML 格式。

InsertContent

字段
content	string 要插入的内容。
mimeType (deprecated)	EmailMimeType 此项已弃用！
contentType	ContentType 插入内容的类型。

类型

枚举
UNSPECIFIED_ACTION_TYPE	未为“类型”设置任何值时的默认值。
IN_PLACE_INSERT	表示此操作是执行原位插入。默认情况下，内容会插入到当前光标位置，如果有选中的内容，则会替换选中的内容。
INSERT_AT_START	表示此操作是在邮件正文开头执行插入操作。
INSERT_AT_END	表示此操作是在消息正文末尾执行插入操作。
REPLACE	表示此操作用于替换邮件正文。

UpdateCcRecipients

字段
ccRecipients[]	Recipient

UpdateSubject

字段
subject	string

UpdateToRecipients

字段
toRecipients[]	Recipient

HostAppActionMarkup

由各个托管应用处理的操作。

字段
联合字段 action。 action 只能是下列其中一项：
gmailAction	GmailClientActionMarkup 由 Gmail 处理的操作。
calendarAction	CalendarClientActionMarkup 由 Google 日历处理的操作。
driveAction	DriveClientActionMarkup 由云端硬盘处理的操作。
editorAction	EditorClientActionMarkup 由文档、表格或幻灯片处理的操作。
sheetsAction	SheetsClientActionMarkup 由 Google 表格处理的操作。

HostAppDataActionMarkup

定义如何更新 Google Workspace 数据。

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

字段
联合字段 action。给定 Google Workspace 宿主应用的插件操作。action 只能是下列其中一项：
chatDataAction	ChatDataActionMarkup 用于在消息中创建或更新文本或卡片的 Google Chat 操作。

HostAppDataSourceMarkup

对于使用多选菜单的 SelectionInput 微件，请使用 Google Workspace 应用中的数据源。数据源会为多选菜单填充选择项。

适用于 Google Chat 应用，不适用于 Google Workspace 插件。

字段
联合字段 data_source。用于为多选菜单填充项的 Google Workspace 应用。data_source 只能是下列其中一项：
chatDataSource	ChatClientDataSourceMarkup Google Chat 中的数据源。

SheetsClientActionMarkup

字段
customFunctionReturnValueMarkup	CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

用户运行自定义函数的结果。

字段
联合字段 result。自定义函数执行的结果。result 只能是下列其中一项：
value	Value 运行自定义函数产生的值。
errorMessage	string 如果发生错误，向用户显示的错误消息。