Method: courses.students.create

将用户添加为课程的学生。

网域管理员可以将其网域内的用户直接添加为网域内的课程的学生。学生可以使用注册代码自行加入课程。

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

  • PERMISSION_DENIED如果请求用户未获准在此课程中创建学生或因访问错误而请求创建学生。
  • 如果请求的课程 ID 不存在,则返回 NOT_FOUND
  • 如果请求的用户的帐号因以下请求错误而被停用,则返回 FAILED_PRECONDITION
    • CourseMemberLimitReached
    • CourseNotModifiable
    • UserGroupsMembershipLimitReached
    • InactiveCourseOwner
  • 如果用户已经是课程中的学生或教师,则为 ALREADY_EXISTS

HTTP 请求

POST https://classroom.googleapis.com/v1/courses/{courseId}/students

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

要在其中创建学生的课程的标识符。此标识符可以是 Google 课堂分配的标识符,也可以是 alias

查询参数

参数
enrollmentCode

string

要为其创建学生的课程的注册代码。如果 userId 对应于发出请求的用户,则必须使用此代码;如果发出请求的用户拥有为任何用户创建学生的管理员权限,则可以省略此代码。

请求正文

请求正文包含一个 Student 实例。

响应正文

如果成功,响应正文将包含一个新创建的 Student 实例。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

有关详情,请参阅授权指南