返回发出请求的用户可以查看的课程列表,仅限与该请求匹配的课程。系统会按创建时间对已发回的课程进行排序,最近创建的课程排在最前面。
此方法会返回以下错误代码:
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[] |
与 list 请求匹配的课程。 |
nextPageToken |
用于标识下一页返回结果的令牌。如果留空,则没有其他结果。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
有关详情,请参阅 OAuth 2.0 概览。