Method: courses.announcements.getAddOnContext

在特定帖子的上下文中获取 Google 课堂插件元数据。

为了维护其自身数据和权限模型的完整性，每当在 iframe 中打开插件时，插件都应调用此方法来验证查询参数和请求用户的角色。

此方法会返回以下错误代码：

  • PERMISSION_DENIED 表示访问错误。
  • 如果请求格式不正确，则返回 INVALID_ARGUMENT。
  • 如果其中一个标识的资源不存在，则返回 NOT_FOUND。

HTTP 请求

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{itemId}/addOnContext

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

必需。课程的标识符。
itemId

string

附件附加到的 Announcement、CourseWork 或 CourseWorkMaterial 的标识符。此字段是必填字段，但在从 postId 迁移期间未被标记为必填字段。

查询参数

参数
addOnToken

string

可选。用于授权请求的令牌。

当用户从 Google 课堂重定向到插件网址时，系统会将令牌作为查询参数传递。

如果不满足以下任一条件，则需要提供授权令牌：

  • 该插件在帖子中包含附件。
  • 发出请求的开发者项目与创建帖子的项目相同。
attachmentId

string

可选。附件的标识符。除非用户位于附件发现 iframe 中，否则所有请求都必须包含此字段。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 AddOnContext 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

如需了解详情，请参阅授权指南。