Google Workspace 插件应与所扩展宿主 应用的设计风格和布局保持一致。它们应使用熟悉的控件和行为自然地扩展界面。此处介绍的准则描述了处理文字、图片、控件和品牌的方式,这些方式有助于提升用户体验。
如果您的插件会打开单独的网页,而这些网页是插件运行不可或缺的一部分(例如插件的设置页面),请确保这些网页也遵循这些设计风格准则。
文字和图片
本部分将介绍如何在插件中使用文字和图片。
插件名称
您必须在插件的项目 清单中设置插件的名称,并在配置插件以进行 发布时设置插件的名称。该名称会显示在许多 位置,例如 Google Workspace Marketplace 商品详情和菜单中。选择名称时,请注意以下事项:
- 采用词首字母大写形式。
- 避免使用标点符号,尤其是圆括号,除非它们是品牌的一部分。
- 名称应简短,最好不超过 15 个字符。在 Google Workspace Marketplace 商品详情和其他位置,过长的名称可能会被自动截断。
- 请勿在插件名称中包含“Google”“Gmail”字样或其他 Google 产品名称。
- 请勿在插件名称中包含“插件”一词。
- 请勿包含版本信息。
写作风格
您应该不需要编写太多内容。大多数操作都应通过图标、布局和简短的标签来明确说明。如果您发现插件的某个部分需要比简短标签更详尽的说明,最好创建一个单独的网页来描述您的插件并提供指向该网页的链接。
编写界面文字时,请注意以下事项:
- 采用句首字母大写的形式(尤其是按钮、标签和卡片操作)。
- 最好使用简短、清晰的文字,避免使用术语或缩写。
通用操作和卡片操作
如果您在插件中使用通用操作或 卡片操作,这些操作会显示在您定义的 卡片中,作为菜单项。您可以为这些操作选择在这些菜单中使用的文字。选择要使用的文字时,请注意以下事项:
- 避免使用与插件名称重复的菜单文字。
- 以操作字词(例如“运行”“配置”或“创建”)开头。
- 描述任务,而不是显示操作的界面组件。
- 如果您的操作会启动工作流,但没有单个动词来描述其功能,请将其命名为“开始”。
- 尽量减少菜单项的数量,以免用户被迫滚动浏览长长的列表。如果您要实现更多操作,请考虑使用多个卡片,每个卡片上显示不同的操作。
错误消息
出现问题时,请务必使用简单易懂的语言。从用户的角度解释问题,并建议如何解决问题。
- 不要让用户看到代码抛出的任何异常。请改用
try...catch语句拦截异常,然后显示用户友好的错误消息。 - 在发布之前,请检查您的插件是否会在界面中显示调试信息。
帮助内容
您可能需要设计卡片,以向用户显示帮助信息或说明插件的操作。如果您确实要为插件构建帮助内容,请务必注意以下事项:
- 尽可能以项目符号列表或编号列表的形式显示说明。引导用户完成整个流程,并明确引用已命名的界面元素。
- 确保您的说明清楚地解释了任何要求,例如以某种方式设置电子表格。
- 您可以随意链接到外部帮助内容,例如支持网页。
Google 图片
插件中使用的图片可以是 内置图标类型之一,也可以是网址指定的公开 托管图片。使用托管图片时,请确保所有可能会使用您的插件的用户都可以访问这些图片。
控件
本部分提供了有关互动式 微件的用户体验准则。
按钮
使用按钮来控制用户界面的主要操作,而不是其他微件。
- 大多数文字按钮标签都应以动词开头。
- 在大多数情况下,按钮行应限制为最多三个按钮。
DecoratedText
借助 DecoratedText 微件 ,您可以显示带有图标、按钮或开关的文字内容。
- 对文字内容采用句首字母大写的形式。
- 如果 DecoratedText 微件的文字无法放入可用空间,则会被截断。因此,请始终尽量缩短文字内容。
选择输入项
您可以在插件中使用各种 选择输入微件 :下拉选择框、复选框、 和单选按钮。
- 当用户可以选择多个选项或不选择任何选项时,请使用复选框。当用户必须选择一个选项时,请使用单选按钮(或选择菜单)。当您提供简短的备选列表,同时又想节省界面空间时,请使用下拉菜单。
- 对分配给每个选项的文字采用句首字母大写的形式。
- 避免使用选择更改来触发重大且难以撤消的操作,因为用户在进行选择时经常会出错。请考虑添加一个按钮,该按钮会读取当前选择的值,然后触发操作。
- 对于下拉菜单,请按字母顺序或所有用户都能理解的逻辑方案对选项进行排序(例如,按顺序显示周几,从周日或周一开始)。
- 将给定选择输入微件中的选项数量限制为合理的数量。如果选项过多,用户可能会发现很难使用该微件。在这种情况下,请考虑将选项分为不同的类别和多个微件。
文本输入内容
文本输入内容为用户提供了一个输入字符串数据的位置。
- 请勿使用文本输入内容让用户输入一组特定可能条目中的一个条目。请改用下拉选择框。
- 使用提示和建议来帮助用户输入格式和内容正确的文字。
- 如果要输入的文字超过几个字,请使用多行文本输入内容。
品牌
本部分提供了有关向插件界面添加品牌元素的用户体验准则。
在插件中
如果您想在插件界面中添加品牌元素,请保持简洁明了。这有助于用户专注于插件的功能。
- 插件的所有方面都必须遵循 品牌准则。
- 请勿包含“Google”“Gmail”字样或其他 Google 产品名称。
- 请勿包含 Google 产品图标,即使经过修改也不行。
- 请勿在品牌文字中包含“插件”一词。
- 品牌文字不应超过几个字。
在 Google Workspace Marketplace 中
在配置插件以进行发布时,您需要提供一些图形和文字素材资源来构建 Google Workspace Marketplace 商品详情。
商品详情和这些素材资源的所有方面都必须遵循品牌 准则。