最佳做法

提升用户的来提升整体体验 Google Meet 插件设计。

授权最佳实践

对于 需要进行身份验证或授权的 Google Meet 插件。

使用 Google 登录功能

许多 Google Workspace 插件用户之前已经登录过 Google 加入会议。因此,设置 Google 登录 在用户浏览 AdSense 内容详情时 登录流程

在新窗口中打开第三方登录页面

除了 Google Sign-In 以外,您的应用可能还会提供其他登录方式 机制。如果是这样,请使用对话框窗口,而不是在 新标签页。这样,用户仍然可以查看并返回到 Meet 通话,并且获得的总点击次数会更少。

正确请求 Google API 的范围

如果您的 Meet 插件调用 Google API,那么: 您必须提供完整的 OAuth 列表 范围 。此操作在 Google Workspace Marketplace 中的“应用配置”页面。添加这些之后 范围时,用户在安装您的 Meet 插件,可告诉用户他们是哪类数据 从而允许您的应用访问

在发布插件之前, 您还必须设置 OAuth 同意 screen。 这要求添加的授权范围您的 Google Workspace Marketplace 中的应用配置。配置 OAuth 同意屏幕还需要设置品牌信息、隐私权政策 请求范围时显示的服务条款和服务条款。要发布 所有此类信息都必须提交 验证

在编写调用 Google Workspace API 的代码时,请遵循 JavaScript 快速入门 是最简单的入门方法。此方法符合 登录账号。请注意,初始化令牌 客户 要求分别请求应用的作用域 在运行时使用的实际服务为提供最佳用户体验,这些请求的范围 应与 Google Workspace Marketplace 中的应用配置中的配置一致 页面。这种冗余为应对以下情况提供了一种后备方案: 一位用户已撤消 范围

维护最佳实践

对于编写可维护的 但在编写任何 Meet 插件。

使用最新版 Google Meet 插件 SDK

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

  • 使用 gstatic 时:最新的 SDK 版本包含在 gstatic 中 SDK 使用说明中的网址。
  • 使用 npm 时:从命令行中运行 npm update @googleworkspace/meet-add-ons 包含 package.json 的目录 。

创建预演 Google Cloud 项目

一旦您的 Google Meet 插件发布到 Google Workspace Marketplace 任何新部署的 Google Meet 插件都会立即生效 可供 Meet 用户参考用户会在第一时间看到这些更新 它们会清空缓存或缓存过期因此,我们建议您不要 将更改推送到生产网站,直到更改经过全面测试。

为避免直接部署到生产环境,我们建议您为 非公开发布的 Google Cloud 项目 您的组织。此 Cloud 项目将托管预演和 Meet 插件的开发环境。访问权限 一个小型团队, 直接开发您的插件。

如需为您的插件创建这些备用环境,请按以下步骤操作: 您首先需要托管您的 Web 应用的其他环境, 包含您的插件(在您拥有的网域中)。然后, 您可以为自己的集群创建备用环境 通过添加其他 的 Meet 插件 部署 您的预演 Google Cloud 项目。这些新部署应该 指向您的 Web 应用的其他环境的清单。 然后,建议您安装这些插件 配置如下:

  • 预演版本以非公开方式发布预演版本 以便您组织中的任何人都可以协助测试。
  • 开发:点击操作列下的安装,以安装 Meet 插件开发版仅适用于你的账号。

编写测试

将 Meet 插件部署到开发环境之前 我们建议您编写单元测试。您的单元测试应该包括:

  • 模拟 Meet 插件 SDK,并验证 Meet 插件会按预期调用 SDK 函数。
  • 对 SDK 以外的所有功能进行单元测试 插件。

用户体验最佳实践

以下最佳实践有助于创建 Meet 插件 更加直观和完善。

在侧边栏中管理所有开始状态

我们强烈建议您根据 在侧边栏中执行的用户操作。 这是通过将协作开始设置为 州 JavaScript。进入 CollaborationStartingState 应由插件的发起者设置(通常是 会议主持人)。您可以将网站的第一视图看作是 作为表单供您控制 插件。

不使用时关闭侧边栏

通过调用 startCollaboration, 您应只保留侧边栏 如果它是网站用户体验的重要组成部分, Google Meet 插件。在主组件完成之后,您可以关闭侧边栏 通过调用以下方法来打开该阶段unloadSidePanel

通过屏幕共享功能宣传您的 Meet 插件

Meet 插件可提供比屏幕共享更丰富的体验。 不过,许多用户已习惯了 Meet 的屏幕共享功能 功能。如果用户共享的标签页显示托管您的 Meet 插件,可以配置 Meet 以 向所有通话参与者显示横幅,提示他们安装或使用 相应的 Meet 插件。如需了解详情,请参阅 通过屏幕推广您的插件 共享