请遵循以下 Google Meet 插件设计指南,以提升用户的整体体验。
授权最佳实践
对于任何需要进行身份验证或授权的 Google Meet 插件,我们都建议您遵循以下最佳实践。
使用 Google 登录
许多 Google Workspace 插件用户在加入会议之前就已经登录了 Google。因此,如果提供 Google 一键登录选项,用户在完成登录 流程时可以少点击几次。如需了解详情,请参阅管理插件的登录方法。
在新窗口中打开第三方登录页面
除了 Google 登录之外,您的应用还可以提供其他登录机制。如果是这样,请使用对话框窗口,而不是在新标签页中打开登录页面。这样,用户仍然能够看到 Meet 通话并返回到该通话,并且总共点击的次数也会更少。
正确请求 Google API 的范围
如果您的 Meet 插件调用 Google API,则 您必须提供插件所需的 OAuth 范围 的完整列表。您可以在 Google Workspace Marketplace 的“应用配置”页面上完成此操作。添加这些范围后,用户在安装 Meet 插件时会看到提示,告知用户他们允许您的应用访问哪些类型的数据。
在发布插件之前, 您还必须设置OAuth 权限请求 页面。 这需要添加与 Google Workspace Marketplace 的“应用配置”页面中 完全 相同的授权范围。配置 OAuth 权限请求页面还需要设置在请求范围时显示的品牌信息、隐私权政策和服务条款。如需公开进行发布,您必须提交所有这些信息以供验证。
在编写用于调用 Google Workspace API 的代码时,最简单的入门方法是遵循 JavaScript 快速入门 。这种方法遵循了使用 Google 登录和对话框窗口的最佳实践。请注意,在 JavaScript 中初始化令牌 客户端 需要单独请求应用在运行时实际使用的范围。为了获得最佳用户体验,这些请求的范围应与 Google Workspace Marketplace 的“应用配置”页面中的范围一致。这种冗余提供了一种回退机制,用于处理 用户撤消 范围的情况。
维护最佳实践
以下最佳实践适用于编写可维护的网络应用,但在编写任何 Meet 插件时尤为重要。
使用最新版本的 Google Meet 插件 SDK
Meet 插件 SDK 会定期更新。该 SDK 遵循 语义化版本控制。如需查找最新版本,请执行以下操作:
- 使用 gstatic 时:最新 SDK 版本包含在使用 SDK 的说明中找到的 gstatic 网址中。
- 使用 npm 时:从包含托管 Meet 插件的网站的
package.json的目录中运行npm update @googleworkspace/meet-add-ons。
创建预演 Google Cloud 项目
Google Meet 插件在 Google Workspace Marketplace 上 发布后,Meet 用户可以立即使用 Google Meet 插件的任何新部署。用户在清空缓存或缓存过期后,会立即看到这些更新。因此,我们建议您在彻底测试更改之前,不要将更改推送到生产网站。
为避免直接部署到生产环境,我们建议您创建一个单独的 Google Cloud 项目,并以私密方式 向您的组织发布该项目。此云项目将托管 Meet 插件的预演环境和开发环境。此 Google Cloud 项目的访问权限应仅限于直接参与插件开发的小团队。
如需为插件创建这些备用环境,您首先需要在您拥有的网域上托管包含插件的 Web 应用的备用环境。然后, 您可以通过向预演 Google Cloud 项目添加其他 部署 来为 Meet 插件创建备用环境。这些新部署应具有指向 Web 应用备用环境的清单。然后,我们建议您按如下方式安装每个插件环境:
- 预演:以私密方式发布预演版本 ,以便组织中的任何人都可以协助进行测试。
- 开发:点击操作列下的安装,将 Meet 插件开发版本仅安装到您的账号。
编写测试
在将 Meet 插件部署到开发环境之前,我们建议您编写单元测试。您的单元测试应包括:
- 模拟 Meet 插件 SDK,然后验证 Meet 插件是否按预期调用 SDK 函数。
- 使用您偏好的网络测试框架对插件的所有非 SDK 相关功能进行单元测试。
用户体验最佳实践
以下最佳实践有助于使 Meet 插件更加直观和完善。
在侧边栏中管理所有起始状态
我们强烈建议您根据用户在侧边栏中执行的操作来设置插件。您可以通过在 JavaScript 中设置 activity 起始
状态来完成此操作。所有进入
ActivityStartingState
的数据都应由插件的发起者(通常是
会议主持人)在侧边栏中设置。您可以将侧边栏的第一个视图视为控制插件设置的表单。
不使用时关闭侧边栏
通过调用
startActivity()
方法启动 activity 后,只有当侧边
栏是 Google Meet 插件用户体验的重要组成部分时,您才应保持侧边栏处于打开状态。您可以在 主舞台打开后通过调用unloadSidePanel()方法关闭侧边栏。
通过屏幕共享推广 Meet 插件
与屏幕共享相比,Meet 插件可提供更丰富的体验。 不过,许多用户习惯使用 Meet 的屏幕共享功能。如果用户共享显示托管 Meet 插件的网站的标签页,您可以将 Meet 配置为向所有通话参与者显示横幅,提示他们安装或使用相应的 Meet 插件。如需了解详情,请参阅 通过屏幕 共享推广插件。
徽标设计指南
设计特定于 Meet 的徽标时,请遵循以下指南,以确保徽标现在和将来都呈现最佳效果:
请使用 PNG 文件格式,尺寸为 256 像素 x 256 像素。
请使用透明度。
请使用 Meet 插件的开发者工具 验证深色模式徽标在深色模式下是否美观。
请使用对比度检查工具(例如 Web Accessibility In Mind (WebAIM) 提供的 Contrast Checker)验证徽标(和 其他图形资源)在高对比度模式下是否美观。
请遵守特定应用集成的图形要求。
请勿在图片中添加内边距。请改为将图片扩展到文件的边界。