Package google.apps.script.type

索引

AddOnWidgetSet

插件使用的 widget 子集。

字段
usedWidgets[]

WidgetType

插件中使用的 widget 的列表。

WidgetType

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

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

CommonAddOnManifest

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

字段
name

string

必需。插件的显示名称。
logoUrl

string

必需。插件工具栏中显示的徽标图片的网址。
layoutProperties

LayoutProperties

插件卡片的常见布局属性。
addOnWidgetSet

AddOnWidgetSet

插件中使用的 widget。如果未指定此字段，则使用默认集。
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。

GranularOauthPermissionSupport

插件是否已启用精细的 OAuth 意见征求。

枚举
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED 默认值，不应使用。
OPT_IN 该插件已选择启用精细 OAuth 许可。
OPT_OUT 相应插件已选择停用精细的 OAuth 许可。

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 不发送身份验证标头。

HttpOptions

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

字段
authorizationHeader

HttpAuthorizationHeader

HTTP 授权标头中发送的令牌的配置。
granularOauthPermissionSupport

GranularOauthPermissionSupport

插件是否已启用精细的 OAuth 意见征求。

LayoutProperties

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

字段
primaryColor

string

插件的主色调。它用于设置工具栏的颜色。如果未设置任何主色调，则使用框架提供的默认值。
secondaryColor

string

附加服务的辅助颜色。用于设置按钮的颜色。如果设置了主要颜色，但未设置次要颜色，则次要颜色与主要颜色相同。如果未设置主色调和次色调，则使用框架提供的默认值。
useNewMaterialDesign
(deprecated)

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。

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

字段
runFunction

string

必需。激活此扩展点时要执行的端点。
label

string

必需。描述激活此扩展点所采取操作的用户可见文本。例如，“插入发票”。
logoUrl

string

插件工具栏中显示的徽标图片的网址。

如果未设置，则默认为插件的主徽标网址。

UniversalActionExtensionPoint

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

字段
label

string

必需。用户可见的文本，用于描述激活此扩展点后执行的操作，例如“添加新联系人”。
联合字段 action_type。必需。通用操作菜单项支持的操作类型。它可以是用于打开的链接，也可以是用于执行的端点。action_type 只能是下列其中一项：
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 留空。