您的用户是通过 Google Meet 使用 Google 课堂吗?请查看 Apps 脚本快速入门 - 了解如何在 Google Meet 课程中查看学生出席情况

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

有关详情,请参阅 OAuth 2.0 概览