请遵循以下 Google Meet 插件设计指南,提升用户的整体体验。
授权最佳实践
我们建议您针对任何需要身份验证或授权的 Google Meet 插件采用以下最佳实践。
使用 Google 账号登录
许多 Google Workspace 插件用户在加入会议之前就已登录 Google。因此,提供 Google One Tap 选项可让用户在完成登录流程时减少几次点击。如需了解详情,请参阅管理插件登录方法。
在新窗口中打开第三方登录页面
除了 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 应用配置页面中的范围一致。这种冗余提供了一种回退方式,用于处理用户已撤消范围的情况。
维护最佳实践
以下最佳实践适用于编写可维护的 Web 应用,但在编写任何 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 项目,并将其私下发布给贵组织。此 Cloud 项目将托管 Meet 插件预演环境和开发环境。此 Cloud 项目的访问权限应仅限于直接负责开发您的插件的小型团队。
如需为您的插件创建这些备用环境,您首先需要在您拥有的域名上托管包含该插件的 Web 应用的备用环境。然后,您可以通过向预演版 Google Cloud 项目添加其他 部署,为 Meet 插件创建备用环境。这些新部署应具有指向 Web 应用备用环境的清单。然后,我们建议您按如下方式安装每个插件环境:
- 预演版:以非公开方式发布预演版,以便贵组织中的任何人都可以协助测试。
- 开发:点击“操作”列下的安装,将 Meet 插件开发版本仅安装到您的账号。
编写测试
在将 Meet 插件部署到开发环境之前,我们建议您编写单元测试。您的单元测试应包含:
- 模拟 Meet 插件 SDK,然后验证 Meet 插件是否按预期调用 SDK 函数。
- 使用首选的 Web 测试框架对插件中的所有非 SDK 相关功能进行单元测试。
用户体验最佳实践
以下最佳实践有助于让 Meet 插件更加直观和精致。
在侧边栏中管理所有起始状态
我们强烈建议您根据用户在侧边栏中执行的操作来设置插件。为此,您可以在 JavaScript 中设置 activity 启动状态。进入 ActivityStartingState
的所有数据都应由插件发起者(通常是会议主持人)在侧边栏中设置。您可以将侧边栏的第一个视图视为用于控制插件设置的表单。
在不使用时关闭侧边栏
通过调用 startActivity()
方法启动 activity 后,您应仅在边栏是 Google Meet 插件用户体验的重要组成部分时才将其保持打开状态。主舞台打开后,您可以通过调用 unloadSidePanel()
方法关闭侧边栏。
通过屏幕共享宣传您的 Meet 插件
Meet 插件可提供比屏幕共享更丰富的体验。不过,许多用户已经习惯使用 Meet 的屏幕共享功能。如果用户共享的标签页显示了托管 Meet 插件的网站,Meet 可以配置为向所有通话参与者显示横幅,提示他们安装或使用相应的 Meet 插件。如需了解详情,请参阅通过屏幕共享宣传您的插件。
徽标设计指南
在设计 Meet 专用徽标时,请遵循以下准则,以确保徽标在现在和未来都能呈现最佳效果:
请使用 PNG 文件格式,大小为 256 像素 x 256 像素。
请使用透明度。
请使用 Meet 插件开发者工具,验证您的深色模式徽标在深色模式下是否看起来不错。
请遵守特定应用集成的图形要求。
请勿在图片中添加内边距。请改为将图片扩展到文件边界。