Package apps.extensions.markup

索引

CalendarClientActionMarkup

字段
editAttendeesActionMarkup

EditAttendeesActionMarkup

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

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

一种将会议数据添加到 Google 日历活动的操作。第三方会议插件只能在 Apps 脚本中构建。

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

一种可将附件添加到 Google 日历活动的操作。

createConferenceDataActionMarkup

CreateConferenceDataActionMarkup

在创建 Google 日历活动时显示会议数据的操作。

createConferenceSettingUrlActionMarkup

CreateConferenceSettingUrlActionMarkup

一种用于生成创建会议设置网址的操作。

calendarSubscriptionActionMarkup

CalendarSubscriptionActionMarkup

用于管理日历订阅的操作。仅支持在 HTTP 端点插件中创建订阅。不适用于 Apps 脚本插件。

AddAttachmentsActionMarkup

字段
addonAttachments[]

AddonAttachment

AddonAttachment

字段
resourceUrl

string

title

string

附件的标题。

mimeType

string

resourceUrl 中内容的 MIME 类型。

iconUrl

string

指向资源图标的链接。

CalendarSubscriptionActionMarkup

字段
operation

Operation

要执行的操作。目前仅支持 CREATE。

calendarId

string

要订阅的日历 ID。

操作

枚举
OPERATION_UNSPECIFIED
CREATE

ConferenceDataMarkup

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

字段
conferenceId

string

相应会议数据的唯一标识符。长度上限为 512 个字符。

entryPoints[]

EntryPointMarkup

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

parameters[]

Parameter

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

error

Error

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

note

string

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

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

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

错误

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

字段
type

Type

错误类型。必填。

authenticationUrl

string

如果错误类型为 AUTHENTICATION,则插件可以提供一个网址,供用户登录。长度上限为 1,300 个字符。

类型

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

参数

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

字段
key

string

参数的键。长度上限为 50 个字符。必填。

value

string

参数值。长度上限为 1024 个字符。必填。

CreateConferenceDataActionMarkup

字段
createConferenceData

ConferenceDataMarkup

创建 Google 日历活动时要添加的会议数据。

CreateConferenceSettingUrlActionMarkup

字段
settingsUrl

string

插件生成的设置页面的 URI。

EditAttendeesActionMarkup

字段
addAttendeeEmails[]

string

要添加到 Google 日历活动中的参加者列表。

EditConferenceDataActionMarkup

字段

联合字段 conference

conference 只能是下列其中一项:

conferenceData

ConferenceDataMarkup

要添加到 Google 日历活动中的会议数据。第三方会议插件只能在 Apps 脚本中构建。

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 聊天室作为项。

ChatDataActionMarkup

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

字段
联合字段 actionGoogle Chat 操作action 只能是下列其中一项:
createMessageAction

CreateMessageAction

以 Google Chat 应用的身份发送消息。

updateMessageAction

UpdateMessageAction

更新 Google Chat 应用的消息。

updateInlinePreviewAction

UpdateInlinePreviewAction

为了预览链接,向 Google Chat 用户的消息添加一张或多张卡片。

CreateMessageAction

聊天应用发送消息。如需了解详情,请参阅发送 Google Chat 消息

字段
message

Message

Google Chat 消息。

UpdateInlinePreviewAction

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

字段
cardsV2[]

CardWithId

一个或多个卡片的数组。

UpdateMessageAction

聊天应用会更新消息中的文本或卡片。如需了解详情,请参阅发送 Google Chat 消息

字段
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 关闭插件撰写界面。

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 表格处理的操作。

HostAppDataActionMarkup

定义如何更新 Google Workspace 数据。

字段
联合字段 action。给定 Google Workspace 宿主应用的插件操作。action 只能是下列其中一项:
chatDataAction

ChatDataActionMarkup

一种 Google Chat 操作,用于在消息中创建或更新文本或卡片。

HostAppDataSourceMarkup

Google Workspace 应用中的数据源。数据源用于填充微件的可用项。

字段
联合字段 data_source。用于填充 widget 可用项的 Google Workspace 应用。data_source 只能是下列其中一项:
chatDataSource

ChatClientDataSourceMarkup

来自 Google Chat 的数据源。

SheetsClientActionMarkup

下一个 ID:5。

字段

联合字段 action

action 只能是下列其中一项:

customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

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

字段
联合字段 result。自定义函数执行的结果。result 只能是下列其中一项:
value

Value

运行自定义函数后得到的值。

errorMessage

string

如果出现问题,向用户显示的错误消息。