Google Workspace 插件的界面样式指南

8еа39680ц8 5138ц2ц823 800е90953а 1685бдфб67

Google Workspace 插件应与 样式和布局 主机应用 扩展。他们应该扩展界面 使用熟悉的控件和行为自然而然地做到这一点。提供的指南 此处介绍了处理宣传文字、图片、控件和品牌信息的方式, 以及高品质的用户体验。

如果插件打开的是独立网页,而这些网页是该插件不可或缺的一部分 操作(例如插件的设置页面),请确保这些网页 也遵循这些样式准则

文字和图片

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

插件名称

您必须在插件的项目中设置插件的名称 manifest 和在 配置插件以进行发布。 该名称会出现在许多地方,例如 Google Workspace Marketplace 。在选择名称时:

  • 采用词首字母大写形式。
  • 避免使用标点符号,尤其是括号,除非是品牌的一部分。
  • 尽量简短 - 最好不超过 15 个字符。长名称可能是 在 Google Workspace Marketplace 产品详情和其他地方自动截断。
  • 请勿添加“Google”“Gmail”字样或其他 Google 产品名称 。
  • 请勿添加“插件”一词。
  • 省略版本信息。

写作风格

您无需撰写太多内容。大多数操作都应通过 图标、布局和简短标签。如果您发现部分插件 需要比短标签提供更详尽的解释, 练习创建一个单独的网页来说明您的插件并链接到该页面。

编写界面文本时:

  • 采用句首字母大写形式(尤其是针对按钮、标签和卡片操作)。
  • 首选不含行话或首字母缩写词的简短文字。

通用和卡片操作

如果您使用通用操作卡片操作 插件会在卡片中显示为菜单项 定义。您可以为这些菜单选择在相应的菜单中使用的文字 操作。选择要使用的文字时:

  • 避免在菜单上直接重复插件名称。
  • 以“Run”“Configure”等操作字词开头或 “Create”(创建)。
  • 请描述任务,而不是操作显示的界面组件。
  • 如果您的操作启动了一个工作流程,并且没有一个动词能够描述 并将其命名为“Start”
  • 尽量减少菜单项的数量,以免强制用户滚动页面 大量数据。如果您需要执行更多操作,请考虑使用 多张卡片,每张卡片可分别执行不同的操作。

错误消息

如果出现问题,请务必使用通俗易懂的语言。解释 并提出解决方法的建议。

  • 不允许用户查看您的代码抛出的任何异常。相反, 使用 try...catch 语句拦截异常,然后显示 提供直观易懂的错误消息。
  • 发布之前,请检查您的插件是否不显示调试信息 。

帮助内容

您可以设计一些卡片来显示帮助信息或解释 执行该插件的操作。如果您确实为 插件,请务必:

  • 请尽可能以项目符号列表或编号列表形式显示说明。步行用户 一直展示到最终结果,并明确引用已命名的界面元素。
  • 请确保相关说明清楚地解释了所有要求,例如设置 以特定方式创建电子表格
  • 您可以随意链接到外部帮助内容,例如支持网页。

图片

你的插件中使用的图片要么是 内置图标类型 或由网址指定的公开托管图片使用托管的图片时 请确保所有可以使用您插件的用户都能访问这些文件。

控件

本部分提供适用于 互动式微件

按钮

使用按钮来控制界面上的主要操作 其他微件

  • 大多数文本按钮标签都应以动词开头。
  • 大多数情况下,按钮行数不应超过三个按钮。

DecoratedText

DecoratedText 微件 可让您使用图标、按钮或开关展示文本内容。

  • 对文本内容采用句首字母大写形式。
  • 如果 DecoratedText 微件的文本无法放入 可用空间。因此,请始终将文本内容 尽可能简短

选择输入内容

您可以使用各种 选择输入 widget 下拉选择框、复选框和单选按钮。

  • 如果用户可以选择多个选项或根本没有任何选项,请使用复选框。 如果必须选择一个选项,请使用单选按钮(或选择菜单)。 尝试提供备选方案时使用下拉菜单 节省界面中的空间
  • 为每个选项指定的文本采用句首字母大写形式。
  • 避免使用选择更改来触发难以逆转的重大操作。 因为用户在做选择时常常会犯错。您可以考虑改为 添加一个按钮,该按钮可读取当前选择值,然后触发 操作。
  • 对于下拉菜单,请按字母顺序或逻辑方案对选项进行排序 所有用户均可理解(例如,显示星期几 从星期日或星期一开始)。
  • 限制给定选择输入中的选项数量 合理数量。如果选项太多,用户可能会发现 这个微件很难用在这种情况下,请考虑停用 分为不同的类别和多个微件。

文本输入

文本输入为用户提供输入字符串数据的位置。

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

品牌

本部分提供了有关添加品牌元素的用户体验指南 插件界面中

在插件中

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

  • 该插件的所有方面都必须遵循 品牌推广指南
  • 请勿包含“Google”“Gmail”一词或其他 Google 产品名称。
  • 请勿添加 Google 产品图标,即使图标已经过修改也不例外。
  • 请勿添加“插件”一词。
  • 品牌文字不应超过几个字词。

在 Google Workspace Marketplace 中

配置用于发布的插件后, 您可以提供多种图形资源和文字资源, Google Workspace Marketplace 产品详情。

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