Package apps.extensions.markup

索引

CalendarClientActionMarkup

字段
editAttendeesActionMarkup

EditAttendeesActionMarkup

将参加者添加到 Google 日历活动的操作。

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

将会议数据添加到 Google 日历活动的操作。

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

向 Google 日历活动添加附件的操作。

AddAttachmentsActionMarkup

字段
addonAttachments[]

AddonAttachment

AddonAttachment

字段
resourceUrl

string

title

string

附件的标题。

mimeType

string

resourceUrl 中内容的 MIME 类型。

iconUrl

string

指向资源图标的链接。

ConferenceDataMarkup

用于定义与 Google 日历活动关联的会议数据的标记。

字段
conferenceId

string

此会议数据的唯一标识符。长度不得超过 512 个字符。

entryPoints[]

EntryPointMarkup

会议的入口点。最多允许 300 个入口点。

parameters[]

Parameter

其他插件参数。最多允许 300 个参数。

error

Error

如果设置此参数,则表示会议创建过程中出错。

note

string

向用户显示的其他备注(例如管理员的说明、法律声明)。可以包含 HTML。长度上限为 2048 个字符。

conferenceSolutionId

string

会议解决方案的标识符。必须与部署的 calendar.conferenceSolution.id 字段中的值匹配。

EntryPointMarkup

加入会议的方式。

字段
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 入口点。主叫方拨打免费电话是免费的。号码不能既是收费号码,又是免费号码。

类型

入口点的类型。

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

错误

表示会议创建期间发生的错误。

字段
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 日历活动的会议数据。

ChatClientActionMarkup

此类型没有任何字段。

由聊天客户端处理的操作。

ChatClientDataSourceMarkup

使用多选菜单的 SelectionInput widget(来自 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 聊天室选为一项内容。

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

由 Google 文档、表格或幻灯片处理的操作。

sheetsAction

SheetsClientActionMarkup

由 Google 表格处理的操作。

chatAction

ChatClientActionMarkup

由 Chat 处理的操作。

HostAppDataSourceMarkup

使用多选菜单的 SelectionInput widget,即来自 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

出现问题时向用户显示的错误消息。