Google Cloud 项目配置

本页包含您在创建广告系列和 为 Google 课堂插件配置 Google Cloud 项目。 使用 Google Cloud 项目通过 OAuth 2.0 实现 Google 单点登录 （Google 单点登录）、授权插件发出的请求，以及管理 在 Google Workspace Marketplace 中上架插件 。

有关如何将插件发布到 Marketplace 请参阅发布应用。

创建 Google Cloud 项目

有两种类型的项目可供创建：专用项目，用于 和最终用户可访问的公共项目。“公众”和 “private”标签是指您的应用在 Google Workspace Marketplace；私下交易市场 应用只能由其所在的域内的用户进行安装 ，而 Marketplace 公开应用 可供任何 Google Workspace 网域使用。这两个项目必须是 因为项目不能同时设为公开和私有公共应用 必须先经过审核并获得批准，然后才能在 Marketplace 上架。

如需一般 Google Cloud 项目创建信息，请访问创建 Google Cloud 项目。

创建公共 Google Cloud 项目

此项目代表可供 管理员、教师和学生必须对公共项目进行审核 必须经过 Google Workspace Marketplace 团队的批准后才能发布，或者 已安装。

  1. 在生产网域中创建一个新的 Google Cloud 项目。

    创建 Google Cloud 项目

  2. 在您的 Cloud 项目中启用 Classroom API。

    启用 Classroom API

  3. 在您的 Cloud 项目中启用 Google Workspace Marketplace SDK。

    启用 Google Workspace Marketplace SDK

  4. 设置 Marketplace SDK 应用配置 将应用公开范围设为公开，然后选中不公开复选框。

  5. 填写 Marketplace SDK 中的必填字段 商品详情页面，然后点击 发布。

  6. Google Workspace Marketplace 团队将审核您的应用。他们 将使用 Marketplace SDK。应用获得批准后，请清除 不公开框，以便教师和管理员可以在 市场。

创建专用 Google Cloud 项目

此私有项目代表用于开发的插件应用。 创建该密钥所在网域外的用户将无法访问该文件，但是 无需经过批准即可安装。因此，Google 建议 使用此项目在受控环境中开发和测试您的插件。

您需要拥有 Google Workspace 教育版网域的访问权限，并且需要学习或 Plus 版 许可以创建专用项目。如果您目前无权访问此类应用 请按照以下步骤设置 Google Workspace 教育版演示域名，将其升级为 再获得许可，并允许其访问 Classroom 插件 API：

  1. 完成获取开发者测试网域的步骤。

  2. 以管理员身份登录演示网域后，创建一个新的 Google Cloud 项目。

    创建 Google Cloud 项目

    如果您无法访问 Google Cloud 控制台或 Cloud 项目中，请查看 管理控制台：

    • 访问账号设置 >基于年龄的访问权限设置页面，以及 选择此群组或组织部门中的所有用户均为 18 岁或 更早版本。
    • 在应用程序 >附加 Google 服务：
    • 对所有人启用 Google Cloud Platform。
    • 项目创建设置已设为允许用户创建项目。
    • Cloud Shell 访问权限设置为允许访问 Cloud Shell。

  3. 填写并提交演示网域升级请求表单。正在提交此内容 表单请求 Google 将您的演示网域升级到 并允许您的 Cloud 项目进入 Google 课堂插件 API。

    当升级流程和许可名单流程完成时，您会收到一封电子邮件 。在中为您的测试教师账号分配 Plus 许可 管理控制台。低于 目录 >用户，创建或选择考试教师账号。在每个 教师的许可，请确认 Google Workspace 教育 Plus 版已已分配。

  4. 在您的 Cloud 项目中启用 Classroom API。

    启用 Classroom API

  5. 在您的 Cloud 项目中启用 Google Workspace Marketplace SDK。

    启用 Google Workspace Marketplace SDK

  6. 设置 Marketplace SDK 应用配置 将应用公开范围设为不公开。

  7. 填写 Marketplace SDK 中的必填字段 商品详情页面，然后点击 发布。应用详情发布后，网域中的用户 可以在 Google Workspace Marketplace 中找到并安装该应用，或者 访问“商品详情”页面中显示的应用网址。

OAuth 2.0

要访问 Classroom API，必须征得用户同意。这些 通过请求 Google 访问已登录用户的 OAuth 范围来获取 用户收到一个令牌，该令牌随后可用于对 Google 课堂。必须在 Google Workspace Marketplace 的商品详情，以便网域管理员进行 可以代表网域用户在安装该插件时表示同意。

由于“课堂”范围是敏感范围，因此您必须请求 OAuth 验证。否则，用户会看到警告 表明应用未经验证，且只有少数用户 将能够访问您的产品。请参阅审核序列概览 。

请参阅 Google API 的 OAuth 范围页面，查看所有可用 API 的详细列表。 范围及其用途。请参阅 Workspace 文档中的配置 OAuth 页面 了解常规 OAuth 配置信息

用户权限

您的 Web 应用应请求至少一个以下范围：

  • https://www.googleapis.com/auth/userinfo.email，它允许 应用以查看用户的电子邮件地址。
  • https://www.googleapis.com/auth/userinfo.profile，它允许 用于查看个人信息（如肖像、名字和姓氏）的应用程序 姓名，以及用户已公开的其他个人信息 可用。

用户在您的插件中对其中某个范围进行授权后， 由 login_hint 查询参数标识。此参数会传递给 。如果用户尚未授权 这些范围内，login_hint 将不会发送。

login_hint 是标准的 OpenID Connect 参数，您可以选择 传递给 Google。它 旨在为最终用户提供更顺畅的授权体验。

课堂插件范围

以下范围仅适用于 Google 课堂插件：

  • https://www.googleapis.com/auth/classroom.addons.teacher，它允许 所有 API 方法的访问权限。
  • https://www.googleapis.com/auth/classroom.addons.student，它允许 拥有启动验证和附件读取操作的权限。

即使拥有表示用户凭据的有效 OAuth 访问令牌，API 调用 额外要求必须符合以下要求：

  • 所有方法都要求用户是课程中的教师或学生 由 courseId 指定。
  • 创建、更新、删除和回传成绩需要用户 成为一名教师
  • 特定 Google 课堂帖子的来电受以下因素控制： 检查。
    • 如果插件在帖子中已有至少 1 个附件，该插件可以 提出请求： <ph type="x-smartling-placeholder">
        </ph>
      • iframe 启动验证
      • 读取、更新和删除附件操作
      • 根据该信息更新成绩
    • 首次打开附件发现 iframe 时，该插件可能会 帖子中还没有附件。addOnToken 查询参数 可用于针对以下各项发出请求： <ph type="x-smartling-placeholder">
        </ph>
      • 在帖子下创建附件（必须提供 addOnToken）
      • 启动验证（如果提供 addOnToken，则进行验证 如果该插件在 帖子）

OAuth 验证

Google 课堂插件使用 Google API 访问 Google 用户的数据。

请参阅 OAuth API 验证常见问题解答，详细了解 验证流程。

Google Workspace Marketplace 产品详情

如需获取常规 Google Workspace Marketplace SDK 配置信息，请访问 启用并配置 Google Workspace Marketplace SDK，以及 创建 Google Workspace Marketplace 商品详情。

列表注意事项

您的公开 Google Cloud 项目的 Marketplace SDK 存储区 Listing 指定您的应用的名称和 提供给最终用户的说明您可以通过多种方式提供这些详细信息， 应用详情下找到不同语言。

请在商品详情中遵守以下准则：

  • 在应用详情下：

    • 避免在应用名称中使用标点符号。例如，使用“我的插件 由我的公司”而不是“我的公司：我的插件”或“我的插件 公司”。

    • 简短说明和详细说明不应包含 完全相同的文字。

    + 确保您已为定价字段选择一个值。这个 字段包括免费、付费（含免费试用）、付费（使用 免费功能和付费价格。您无需指定费用 。

    • 确保您已为类别字段选择一个值。 对于以下情况，学术资源或教师和管理工具可能是不错的选择 Google 课堂插件。

    • 查看 Marketplace 的应用程序中列出的项目 详情说明。

。

  • 在图形资源下：

  • 在支持链接下：

    • 确保您已提供指向您的应用的使用条款 服务。

  • 确保您符合 Google API 品牌推广指南，该指南 涵盖允许使用的名称和说明。

  • 如果您在商品详情中提及任何 Google 产品，请在 商标列表中提供的格式。务必添加 商标 (TM) 符号（如有指定）；请使用“Google 文档 TM”，而不是“Google 文档”。

与 Google 的许可和结算服务集成

如果您想让 Google Workspace Marketplace 中的应用 集成 Google 的许可和结算服务，请访问 Marketplace API。

安装设置

除管理员之外，插件还可以允许单独安装 安装。本页重点介绍了这两种安装方法之间的一些差异 。而不是升级这两种安装类型。您可以选择 是否允许在 Google Workspace Marketplace SDK 中单独安装 “应用配置”页面。

管理员安装

管理员安装可让管理员向 特定访问权限群组或组织部门的用户共享访问权限。仅限 域管理员可以执行管理员安装。通过 管理员可以选择代表所有用户同意所有访问权限范围 网域中；系统不会提示用户同意 由管理员选择执行此操作

以下是有关管理员安装的一些注意事项。

  • 更严格的控制。管理员可以限制哪些用户可以访问 插件。
  • 与许可的兼容性。如果您的应用需要许可 通过管理员引导安装可能有助于确保 合理分配和使用许可， 机构。
  • 减轻最终用户的负担。管理员安装可以减少 增加教师和学生的负担这可能会使用户 点击次数和混淆机会更少。

请参阅在您的网域中安装 Marketplace 中的应用，详细了解如何 执行管理员安装以及组织结构工作原理 详细了解组织部门和访问权限群组。

单独安装

单独安装会将插件添加到用户自己的账号中。用户 在安装期间提示您同意该插件的访问权限范围。

以下是有关单个安装的一些注意事项。

  • 促进采用。更多用户可以从以下位置查看和安装您的插件： Google Workspace Marketplace。如果允许单个安装，系统可能会提示 吸引更多教师采用或宣传您的产品。
  • 管理员测试。管理员可以逐个安装 在批准或安装此应用之前，对其进行测试或评估。 更广泛的群体。

除了代表用户安装插件之外，管理员还可以 维护许可名单，允许用户安装允许个人安装的插件 安装。如果插件不在许可名单中，用户仍然可以看到 在 Google Workspace Marketplace 中列出插件，但无法安装 插件；而是会看到一条消息，说明该插件尚未 可由域管理员安装。请参阅管理 Google Workspace 许可名单中的 Marketplace 中的应用，详细了解此行为。

如需了解更多详情，请参阅 Google Workspace Marketplace 安装设置文档。 。

应用集成

您必须在附件设置 URI 字段中提供启动 iframe 网址。这个 网址用作附件发现 iframe 的 iframe src 值。通过 教师可以使用附件发现 iframe 来查找以下内容或活动： 附加到作业中。

您还必须指定允许附件的所有 URI 前缀 。此功能可阻止附件来自于 未经授权的来源。

如需详细了解这些字段，请参阅 iframe 指南页面。

测试账号

在您的演示域上创建测试账号，以验证您的 非公开插件。要测试在账号之间切换，需要使用两个学生账号 学生的作业。

建议的测试账号：

  • Tammy 教师，tammy.Teacher@<您的演示网域>
  • Sam Student，sam.student@<您的演示网域>
  • Sally Student, sally.student@<您的演示网域>

请按照以下步骤创建新的测试账号：

  1. 登录管理控制台。
  2. 前往用户。
  3. 点击添加新用户（参见图 1）。
  4. 输入用户的信息并分配适当的角色。

点击“添加新用户” 图 1.添加新用户链接 管理控制台

请按照以下步骤创建新的测试组：

  1. 登录管理控制台。
  2. 前往群组。
  3. 点击创建群组（参见图 2）。
  4. 输入群组的成员和所有者。

点击“创建群组” 图 2.创建群组链接在此处的位置 管理控制台