最佳实践

遵循这些 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 应用配置页面中的范围一致。这种冗余提供了一种后备方案,用于处理用户已撤消范围的情况。

维护最佳实践

以下最佳实践适用于编写可维护的 Web 应用,但在编写任何 Meet 加载项时尤为重要。

使用最新版 Google Meet 加载项 SDK

Meet Add-ons SDK 会定期更新。该 SDK 遵循语义化版本控制。如需查找最新版本,请执行以下操作:

  • 使用 gstatic 时:最新 SDK 版本包含在使用 SDK 的说明中找到的 gstatic 网址内。
  • 使用 npm 时:从包含 package.json 的目录中运行 npm update @googleworkspace/meet-add-ons,该目录对应于托管 Meet 加载项的网站。

创建临时 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 加载项的开发者工具验证深色模式徽标在深色模式下的显示效果。

请使用对比度检查工具(例如 Web Accessibility In Mind (WebAIM) 提供的 Contrast Checker)验证您的徽标(和其他图形素材资源)在高对比度模式下是否看起来不错。

请务必遵守针对特定应用集成的图片要求

请勿在图片中添加内边距。改为将图片扩展到文件的边界。