本文档包含 GoogleClassroom 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.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 课堂中查看主题。 |