Package apps.extensions.markup

索引

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 脚本构建。

字段
conferenceId

string

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

entryPoints[]

EntryPointMarkup

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

parameters[]

Parameter

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

error

Error

如果设置,则表示创建会议期间发生错误。

note

string

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

conferenceSolutionId

string

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

EntryPointMarkup

加入会议的方式。第三方会议插件只能使用 Apps 脚本构建。

字段
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 脚本构建。

字段
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 脚本构建。

ChatClientDataSourceMarkup

对于使用多选菜单(Google Chat 中的数据源)的 SelectionInput widget。数据源会为多选菜单填充选择项。例如,用户可以选择自己是成员的 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

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

sheetsAction

SheetsClientActionMarkup

由 Google 表格处理的操作。

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

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