将链接附件升级为 Google 课堂插件附件

教师向 Google 课堂添加第三方内容的一种方式是在作业创建页面中粘贴链接作为链接附件。为了让教师能够利用已有的知识，您现在可以配置插件，让教师将链接附件升级为插件附件。

概览

如果您为插件配置了此功能，则当教师在作业创建页面中粘贴链接附件时，系统会提示他们将链接升级为插件附件。只有在教师已安装该插件的情况下，系统才会提示教师这样做。

教师同意将链接升级为插件附件后，系统会启动 Link Upgrade iframe，并附带以下查询参数：

  • courseId
  • itemId
  • itemType
  • addOnToken
  • urlToUpgrade
  • login_hint（仅当用户已授权您的应用时）

前四个查询参数与在附件发现 iframe 中启动的查询参数相同。urlToUpgrade 查询参数是新参数，可帮助您评估应如何创建插件附件。然后，您可以使用其他查询参数来检查用户是否已登录，并根据 itemType 值调用 courseWork、courseWorkMaterials 或 announcements 的 CreateAddOnAttachment 方法。在 iframe 中，您可以显示加载界面，向教师表明正在创建插件附件。

创建插件附件后，iframe 会关闭，教师可以像往常一样在作业中查看附件。

技术实现细节

本部分重点介绍该功能的一些重要技术细节。

读取 urlToUpgrade 查询参数

当 urlToUpgrade 查询参数在链接升级 iframe 中传递时，会进行 URI 编码。您必须对网址进行解码，才能获得其原始形式。如果您使用的是 JavaScript，则可以使用 decodeURIComponent() 函数来实现此目的。

为了确保此功能的最佳用户体验，请在成功创建插件附件后发送 postMessage。此操作会关闭 iframe。如需了解详情，请参阅 iframe 实现详情页面。

配置详情

如需将此功能集成到插件中，您需要进行以下配置：

  • “链接升级”iframe 的网址：这是教师同意升级后在 iframe 中打开的网址。

  • Classroom 应检测并尝试升级的网址格式：网址格式可包含一个主机和多个路径前缀。

    • 您可以提供多个网址格式。
    • 如果您未提供任何路径前缀，则与主机匹配的任何网址都可以升级。
    • 只有采用 https 方案的网址才能升级。
    • 网址格式不得包含 localhost。
    • 路径前缀不得包含查询参数或网址片段。
    • 路径前缀目前支持通配符，但主机不支持：
      • example.com 是有效的主机，而 /foo 和 /bar/*/baz 是有效的路径前缀。
      • example.*.host.com 不是有效的主机。
    • 路径前缀组件之间的通配符仅匹配单个组件，而不匹配以斜杠分隔的多个组件。假设有一个网址格式，其主机为 example.com，路径前缀为 /bar/*/baz：
      • https://example.com/bar/123/baz 是网址格式的有效匹配项。
      • https://example.com/bar/123/baz/456/789 是网址格式的有效匹配项。
      • https://example.com/bar/123/456/baz 不是有效的网址格式匹配项，因为路径前缀中的通配符与 /123/456/ 不匹配。

开发流程

通过发送电子邮件至 classroom-link-upgrade-external@google.com，提供测试版或正式版插件的链接升级 iframe 网址和网址模式。

您可以为代表 Classroom 加购项的任何 Google Cloud 项目提供配置。建议您先为具有私密显示设置的插件提供配置，以便您在演示网域中进行开发和测试，而不会影响实际用户。

配置启用后，您会收到电子邮件回复。请注意，此功能不支持使用 localhost 的网址格式。

将电子邮件的格式设置为包含以下内容：

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
-   Host:HOST_1
-   Path prefixes:
  -   PATH_PREFIX_1
  -   PATH_PREFIX_2

-   Host:HOST_2
-   Path prefixes:
  -   PATH_PREFIX_3
  -   PATH_PREFIX_4

// add more hosts and path prefixes as needed

替换以下内容：

  • GCP_PROJECT_NUMBER：与插件关联的 Google Cloud 项目的编号。
  • LINK_UPGRADE_IFRAME_URL：应在链接升级 iframe 中打开的网址。
  • HOST_1：Classroom 应检测到的主机。仅支持 https 方案。
  • PATH_PREFIX_1 和 PATH_PREFIX_2：与 HOST_1 关联的路径前缀，Google 课堂应检测到并尝试升级。
  • HOST_2：Classroom 应检测到的主机。仅支持 https 方案。
  • PATH_PREFIX_3 和 PATH_PREFIX_4：与 HOST_2 关联的路径前缀，Google 课堂应检测到并尝试升级。

以下是实现此功能时可以考虑的一些建议。

避免给教师增加额外工作量

我们强烈建议您使用 iframe 来帮助用户登录（如果需要），或显示加载指示器。为提供最佳用户体验，教师在同意将粘贴的链接升级为插件附件后，系统不应再提示教师提供任何其他信息。不过，如果您的插件无法做到这一点，您可以使用链接升级 iframe 来收集所需的其他信息。如果无法升级链接或发生错误，iframe 还可用于通知教师。

添加了便于用户理解的访问权限错误消息

如果教师粘贴并升级了他们无权访问的链接，请在 iframe 中显示一条用户友好的错误消息，以便教师了解此问题。 iframe 还可用于向教师提供访问相应内容的适当权限。