返回发出请求的用户可以查看的课程列表(仅限与请求匹配的课程)。返回的课程按创建时间排序,最新创建的课程排在最前面。
此方法会返回以下错误代码:
PERMISSION_DENIED
- 访问错误。- 如果查询参数格式有误,则返回
INVALID_ARGUMENT
。 - 如果查询参数中指定的任何用户不存在,则返回
NOT_FOUND
。
HTTP 请求
GET https://classroom.googleapis.com/v1/courses
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
studentId |
将返回的课程仅限有学生(具有指定标识符)的课程。该标识符可以是以下项之一:
|
teacherId |
将返回的课程限制为有教师(具有指定标识符)的课程。该标识符可以是以下项之一:
|
courseStates[] |
将返回的课程限制为处于某一指定状态的课程。默认值为 ACTIVE、ARCHIVED、PROVISIONED、DECLINED。 |
pageSize |
要返回的最大项数。零或未指定,表示服务器可以分配最大值。 服务器返回的结果可能会少于指定数量。 |
pageToken |
在其他方面, |
请求正文
请求正文必须为空。
响应正文
列出课程时的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"courses": [
{
object ( |
字段 | |
---|---|
courses[] |
与列表请求匹配的课程。 |
nextPageToken |
标识要返回的下一页结果的令牌。如果为空,表示没有进一步的结果。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
有关详情,请参阅授权指南。