Package google.apps.script.type

索引

• AddOnWidgetSet（消息）
• AddOnWidgetSet.WidgetType（枚举）
• CommonAddOnManifest（消息）
• CreateActionExtensionPoint（消息）
• HomepageExtensionPoint（消息）
• HttpAuthorizationHeader（枚举）
• HttpOptions（消息）
• LayoutProperties（消息）
• LinkPreviewExtensionPoint（消息）
• MenuItemExtensionPoint（消息）
• UniversalActionExtensionPoint（消息）
• UriPattern（消息）

AddOnWidgetSet

插件使用的 widget 子集。

字段
usedWidgets[]	WidgetType 插件中使用的微件列表。

WidgetType

微件类型。WIDGET_TYPE_UNSPECIFIED 是基本 widget 集。

枚举
WIDGET_TYPE_UNSPECIFIED	默认的微件集。
DATE_PICKER	日期选择器。
STYLED_BUTTONS	样式按钮包括填充按钮和停用按钮。
PERSISTENT_FORMS	持久性表单允许在执行操作期间保留表单值。
FIXED_FOOTER	修复了卡片中的页脚。
UPDATE_SUBJECT_AND_RECIPIENTS	更新草稿的主题和收件人。
GRID_WIDGET	网格微件。
ADDON_COMPOSE_UI_ACTION	适用于插件撰写界面的 Gmail 插件操作。

CommonAddOnManifest

在所有插件宿主应用中共享的插件配置。

字段
name	string 必需。插件的显示名称。
logoUrl	string 必需。在插件工具栏中显示的徽标图片的网址。
layoutProperties	LayoutProperties 插件卡的常用布局属性。
addOnWidgetSet	AddOnWidgetSet 插件中使用的微件。如果未指定此字段，则使用默认集。
useLocaleFromApp	bool 是否从托管应用传递语言区域信息。
homepageTrigger	HomepageExtensionPoint 定义将在任何主机的任何上下文中执行的端点。此函数生成的任何卡片始终可供用户使用，但当此插件声明更具针对性的触发器时，这些卡片可能会被内容相关内容所掩盖。
universalActions[]	UniversalActionExtensionPoint 在通用操作菜单中定义扩展点列表，该菜单用作插件设置菜单。扩展点可以是要打开的链接网址，也可以是作为表单提交内容执行的端点。
openLinkUrlPrefixes	ListValue OpenLink 操作只能使用采用 HTTPS、MAILTO 或 TEL 架构的网址。对于 HTTPS 链接，网址还必须与许可名单中指定的一个前缀匹配。如果前缀省略了方案，则系统会假定为 HTTPS。HTTP 链接会自动重写为 HTTPS 链接。

CreateActionExtensionPoint

当用户在 Google Workspace 应用中调用资源创建工作流时触发的触发器的配置。如需了解详情，请参阅通过“@”菜单创建第三方资源。

字段
id	string 必需。用于区分此扩展点的唯一 ID。ID 不得超过 64 个字符，且应采用 [a-zA-Z0-9-]+ 格式。
labelText	string 必需。与资源创建入口点的图标（例如 Create support case）一起显示的文字。此文本是静态文本，会在用户执行插件之前显示。
localizedLabelText	map<string, string> 可选。要本地化为其他语言的 labelText 的映射。请采用 ISO 639 格式设置语言，采用 ISO 3166 格式设置国家/地区，并以连字符 - 分隔。例如 en-US。 如果映射的键中包含用户的语言区域，用户会看到本地化的 labelText 版本。
runFunction	string 必需。在触发资源创建工作流以创建关联时要执行的端点。
logoUrl	string 可选。显示资源创建入口点的图标。如果省略此元素，菜单将使用您的插件工具栏图标 logoUrl。

HomepageExtensionPoint

声明插件首页浏览的常用格式。

字段
runFunction	string 必需。激活此扩展点时要执行的端点。
enabled	BoolValue 可选。如果设置为 false，则会在此上下文中停用主页视图。 如果未设置，则默认为 true。 如果停用了某个插件的自定义首页视图，系统会改为为用户提供通用概览卡片。

HttpAuthorizationHeader

在插件 HTTP 请求中发送的授权标头。

枚举
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED	默认值，等同于 SYSTEM_ID_TOKEN。
SYSTEM_ID_TOKEN	发送项目专用 Google Workspace 插件系统服务账号的 ID 令牌（默认）。
USER_ID_TOKEN	发送最终用户的 ID 令牌。
NONE	请勿发送 Authentication 标头。

HttpOptions

用于向插件 HTTP 端点发送请求的选项。

字段
authorizationHeader	HttpAuthorizationHeader 在 HTTP Authorization 标头中发送的令牌的配置。

LayoutProperties

在所有插件宿主应用中共享的卡片布局属性。

字段
primaryColor	string 插件的主色。它用于设置工具栏的颜色。如果未设置主色，则使用框架提供的默认值。
secondaryColor	string 插件的主色。它用于设置按钮的颜色。如果设置了主色但未设置辅色，则辅色与主色相同。如果未设置主色和辅色，则使用框架提供的默认值。
useNewMaterialDesign	bool 为卡片启用 Material Design。

LinkPreviewExtensionPoint

当用户在 Google 文档、表格或幻灯片文件中输入或粘贴第三方或非 Google 服务中的链接时触发的触发器的配置。

字段
labelText	string 必需。提示用户预览链接的示例智能条状标签的文本，例如 Example: Support case。此文本是静态文本，会在用户执行插件之前显示。
localizedLabelText	map<string, string> 可选。要本地化为其他语言的 labelText 的映射。请采用 ISO 639 格式设置语言，采用 ISO 3166 格式设置国家/地区，并以连字符 - 分隔。例如 en-US。 如果映射的键中包含用户的语言区域，用户会看到本地化的 labelText 版本。
patterns[]	UriPattern 必需。用于触发该插件预览链接的一组网址模式。
runFunction	string 必需。触发链接预览时要执行的端点。
logoUrl	string 可选。在智能条状标签和预览卡片中显示的图标。如果省略，该插件将使用其工具栏图标 logoUrl。

MenuItemExtensionPoint

用于声明在宿主应用中显示的菜单项或按钮的常见格式。

字段
runFunction	string 必需。激活此扩展点时要执行的端点。
label	string 必需。面向用户的文本，用于说明激活此扩展点所执行的操作。例如，“插入账单”。
logoUrl	string 在插件工具栏中显示的徽标图片的网址。 如果未设置，则默认为该插件的主徽标网址。

UniversalActionExtensionPoint

声明通用操作菜单项扩展点的格式。

字段
label	string 必需。用户可见的文本，用于描述激活此扩展点所执行的操作，例如“添加新联系人”。
联合字段 action_type。必需。通用操作菜单项支持的操作类型。它可以是要打开的链接，也可以是要执行的端点。action_type 只能是下列其中一项：
openLink	string 要由 UniversalAction 打开的网址。
runFunction	string 由 UniversalAction 运行的端点。

UriPattern

触发链接预览的每个网址格式的配置。

字段
hostPattern	string 每个网址格式都必须提供此属性，才能进行预览。网址格式的域名。该插件会预览网址中包含此网域的链接。如需预览特定子网域（例如 subdomain.example.com）的链接，请添加该子网域。如需预览整个网域的链接，请将星号 (*) 作为子网域指定为通配符。 例如，*.example.com 与 subdomain.example.com 和 another.subdomain.example.com 匹配。
pathPrefix	string 可选。用于附加 hostPattern 网域的路径。 例如，如果网址主机格式为 support.example.com，如需匹配托管在 support.example.com/cases/ 的支持请求的网址，请输入 cases。 如需匹配主机模式网域中的所有网址，请将 pathPrefix 留空。