本文档包含特定于 Google 课堂 API 的授权和身份验证信息。在阅读本文档之前,请务必先阅读 了解身份验证和授权,熟悉 Google Workspace 的一般身份验证和授权知识。
配置 OAuth 2.0 以进行授权
配置 OAuth 权限请求页面并选择范围 以定义向用户和应用审核者显示哪些信息,并注册 应用以便日后发布。
Classroom API 范围
如需定义授予应用的访问权限级别,您需要识别并声明 授权范围。授权范围是 OAuth 2.0 URI 字符串,其中包含 Google Workspace 应用名称、访问的数据类型以及访问权限级别。范围是您的应用与 Google Workspace 数据(包括 用户的 Google 账号数据)进行交互的请求。
安装应用后,系统会要求用户验证应用使用的范围。通常,您应尽可能选择范围最窄的范围,并避免请求应用不需要的范围。用户更乐意向描述清晰的有限范围授予访问权限。
Classroom API 支持以下范围:
| 范围 | 含义 |
|---|---|
https://www.googleapis.com/auth/classroom.addons.teacher
|
针对您在 Google 课堂中教授的课程,查看、创建和更新请求 Google Cloud 项目的流项附件 。 |
https://www.googleapis.com/auth/classroom.addons.student
|
在 Google 课堂中查看和更新请求 Google Cloud 项目的流 项附件。 |
https://www.googleapis.com/auth/classroom.announcements
|
在 Google 课堂中查看和管理通告。 |
https://www.googleapis.com/auth/classroom.announcements.readonly
|
在 Google 课堂中查看通告。 |
https://www.googleapis.com/auth/classroom.courses
|
查看、修改、创建及永久删除您的 Google 课堂课程。 |
https://www.googleapis.com/auth/classroom.courses.readonly
|
查看您的 Google 课堂课程。 |
https://www.googleapis.com/auth/classroom.coursework.me
|
查看、创建和修改课程作业项目,包括作业、题目和成绩。 |
https://www.googleapis.com/auth/classroom.coursework.me.readonly
|
查看您在 Google 课堂中的课程作业和成绩。 |
https://www.googleapis.com/auth/classroom.coursework.students
|
管理您在 Google 课堂中教授的课程的学生课程作业和成绩,并查看您管理的课程的学生课程作业和成绩。 |
https://www.googleapis.com/auth/classroom.coursework.students.readonly
|
查看您在 Google 课堂中教授或管理的课程的学生课程作业和成绩。 |
https://www.googleapis.com/auth/classroom.courseworkmaterials
|
在 Google 课堂中查看、修改和创建课业资料。 |
https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly
|
查看您的 Google 课堂课程的所有课业资料。 |
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
|
查看您在 Google 课堂中的课程所面向的学生的监护人。 |
https://www.googleapis.com/auth/classroom.guardianlinks.students
|
查看和管理您在 Google 课堂中的课程所面向的学生的监护人。 |
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
|
查看您在 Google 课堂中的课程所面向的学生的监护人。 |
https://www.googleapis.com/auth/classroom.profile.emails
|
查看您课程中用户的电子邮件地址。 |
https://www.googleapis.com/auth/classroom.profile.photos
|
查看您课程中用户的个人资料照片。 |
https://www.googleapis.com/auth/classroom.push-notifications
|
接收有关您的 Google 课堂数据的通知。 |
https://www.googleapis.com/auth/classroom.rosters
|
管理您 Google 课堂课程的参与者名单。 |
https://www.googleapis.com/auth/classroom.rosters.readonly
|
查看您 Google 课堂课程的参与者名单。 |
https://www.googleapis.com/auth/classroom.student-submissions.me.readonly
|
查看您在 Google 课堂中的课程作业和成绩。 |
https://www.googleapis.com/auth/classroom.student-submissions.students.readonly
|
查看您在 Google 课堂中教授或管理的课程的学生课程作业和成绩。 |
https://www.googleapis.com/auth/classroom.topics
|
在 Google 课堂中查看、创建和修改主题。 |
https://www.googleapis.com/auth/classroom.topics.readonly
|
在 Google 课堂中查看主题。 |