Google Workspace 插件的界面样式指南

Google Workspace 插件应与其扩展的托管应用的样式和布局保持一致。他们应使用熟悉的控件和行为自然地扩展界面。本文档介绍了一些指南，说明了如何处理文字、图片、控件和品牌元素，以提升用户体验的质量。

如果您的插件会打开是其操作不可或缺的部分的单独网页（例如插件的设置页面），请确保这些网页也遵循这些样式准则。

文字和图片

本部分介绍了如何在您的插件中正确使用文本和图片。

插件名称

您必须在其项目清单中设置插件名称，并在配置插件以供发布时设置插件名称。此名称会显示在许多位置，例如 Google Workspace Marketplace 商品详情和菜单中。选择名称时，请注意以下几点：

  • 采用词首字母大写形式。
  • 除非是在品牌名称中，否则请避免使用标点符号，尤其是圆括号。
  • 请保持简短，最好不超过 15 个字符。在 Google Workspace Marketplace 商品详情和其他位置，系统可能会自动截断长名称。
  • 请勿在插件名称中包含“Google”“Gmail”或其他 Google 产品名称。
  • 请勿在插件名称中添加“插件”一词。
  • 省略版本信息。

写作风格

您无需写太多内容。大多数操作都应通过图标、布局和简短的标签清晰呈现。如果您发现您的某个插件需要更详细的说明，而简短的标签无法提供，最佳做法是创建一个单独的网页来介绍该插件，并提供指向该网页的链接。

编写界面文本时：

  • 使用句首字母大写格式（尤其是对于按钮、标签和卡片操作）。
  • 最好使用简短、简单的文本，避免使用专业术语或首字母缩写词。

通用操作和卡片操作

如果您在插件中使用通用操作或卡片操作，它们会显示为您定义的卡片中的菜单项。您可以选择这些菜单中用于执行这些操作的文本。选择要使用的文本时，请注意以下事项：

  • 避免菜单文本仅重复您的插件名称。
  • 每个菜单项都应以动词开头，例如“运行”“配置”或“创建”。
  • 描述任务，而不是操作显示的界面组件。
  • 如果您的操作会启动工作流，但没有单个动词可以描述其用途，请将其命名为“开始”。
  • 请尽量减少菜单项的数量，以免迫使用户滚动浏览庞大的列表。如果您要实现更多操作，不妨考虑使用多个卡片，并在每个卡片上提供不同的操作。

错误消息

当出现问题时，请务必使用简单明了的语言。从用户的角度说明问题，并建议解决方法。

  • 请勿允许用户查看您的代码抛出的任何异常。而是应使用 try...catch 语句拦截异常，然后显示便于用户理解的错误消息。
  • 在发布之前，请检查您的插件是否在界面中显示调试信息。

帮助内容

您可以设计卡片来显示帮助信息或向用户说明插件操作。如果您要为插件构建帮助内容，请务必：

  • 请尽可能以项目符号列表或编号列表的形式显示说明。引导用户完成最终结果，并明确引用命名的界面元素。
  • 请确保说明中明确说明所有要求，例如以特定方式设置电子表格。
  • 您可以随意链接到外部帮助内容，例如支持网页。

图片

您在插件中使用的图片可以是内置图标类型之一，也可以是通过网址指定的公开托管的图片。使用托管的图片时，请确保所有可能使用您的插件的人都可以访问这些图片。

控件

本部分提供了有关交互式 widget 的用户体验准则。

按钮

使用按钮控制界面的主要操作，而不是其他 widget。

  • 大多数文本按钮标签都应以动词开头。
  • 在大多数情况下，按钮行应限制为三个按钮或更少。

DecoratedText

借助 DecoratedText 微件，您可以使用图标、按钮或开关来呈现文本内容。

  • 对文本内容采用句首字母大写形式。
  • 如果 DecoratedText widget 的文本无法放入可用空间，系统会截断该文本。因此，请始终尽量缩短文字内容。

选择输入

您可以在插件中使用各种选择输入微件：下拉选择框、复选框和单选按钮。

  • 当用户可以选择多个选项或根本不选择任何选项时，请使用复选框。 当必须选择一个选项时，请使用单选按钮（或选择菜单）。在提供替代方案的简短列表时，请使用下拉列表，同时尽量节省界面空间。
  • 为每个选项分配的文本使用句首字母大写格式。
  • 避免使用选择更改触发难以撤消的重大操作，因为用户在进行选择时经常会出错。请改为考虑添加一个按钮，用于读取当前选择值，然后触发相应操作。
  • 对于下拉菜单，请按字母顺序或按所有用户都能理解的逻辑方案对选项进行排序（例如，按顺序显示星期几，从星期日或星期一开始）。
  • 将给定选择输入 widget 中的选项数量限制在合理范围内。如果选项过多，用户可能会难以使用该微件。在这种情况下，不妨考虑将选项拆分为不同的类别和多个微件。

文本输入

文本输入框可供用户输入字符串数据。

  • 请勿使用文本输入框让用户输入一组特定可能条目中的某个条目。请改用下拉菜单选择器。
  • 使用提示和建议来帮助用户输入正确格式和内容的文本。
  • 如果要输入的文字不止几个字，请使用多行文本输入。

品牌

本部分提供了有关向插件界面添加品牌元素的用户体验准则。

在您的插件中

如果您想在插件界面中添加品牌信息，请确保品牌信息简洁明了。这有助于用户专注于您的插件功能。

  • 您的插件在所有方面都必须遵循品牌推广指南。
  • 请勿使用“Google”“Gmail”或其他 Google 产品名称。
  • 请勿添加 Google 产品图标，即使经过了修改也是如此。
  • 请勿在品牌推广文案中添加“插件”一词。
  • 品牌文案不应超过几个字。

在 Google Workspace Marketplace 中

在配置插件以供发布时，您需要提供一些图形和文字资源，以便构建 Google Workspace Marketplace 商品详情。

商品详情和这些资源的所有方面都必须遵循品牌推广指南。