Method: courses.students.list

返回允许请求者查看此课程的学生列表。

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

  • 如果课程不存在，则返回 NOT_FOUND。
  • PERMISSION_DENIED 表示访问错误。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
courseId

string

课程的标识符。此标识符可以是 Google 课堂分配的标识符，也可以是 alias。

查询参数

参数
pageSize

integer

要返回的项数上限。如果未指定，则默认值为 30，或者为 0。

服务器返回的结果数可能会少于指定的数量。
pageToken

string

从上一个 list 调用返回的 nextPageToken 值，表示应返回下一页结果。

list 请求在其他方面必须与生成此令牌的请求相同。

请求正文

请求正文必须为空。

响应正文

列出学生时的回复。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
字段
students[]

object (Student)

与列表请求匹配的学生。
nextPageToken

string

标识下一页要返回结果的令牌。如果为空，则没有更多结果。

授权范围

需要以下 OAuth 范围之一：

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

有关详情，请参阅授权指南。