获取特定帖子上下文中的 Google 课堂插件元数据。
为了保持其自身数据和权限模型的完整性,无论何时在 iframe 中打开该插件,插件都应调用此函数来验证查询参数和发出请求的用户的角色。
此方法会返回以下错误代码:
PERMISSION_DENIED
:访问错误。- 如果请求格式有误,则返回
INVALID_ARGUMENT
。 - 如果其中一个已标识的资源不存在,则为
NOT_FOUND
。
HTTP 请求
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{itemId}/addOnContext
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
courseId |
必需。课程的标识符。 |
itemId |
附件所属的通知、courseWork 或 courseWorkMaterial 的标识符。此字段是必填字段,但在从 postId 迁移时未标记为必填字段。 |
查询参数
参数 | |
---|---|
addOnToken |
可选。用于向请求授权的令牌。 当用户从 Google 课堂重定向到插件的网址时,系统会将令牌作为查询参数传递。 如果同时满足以下两个条件,则必须提供授权令牌:
|
请求正文
请求正文必须为空。
响应正文
如果成功,则响应正文包含一个 AddOnContext
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
有关详情,请参阅授权指南。