返回请求用户有权查看的课程列表,仅限与该请求匹配的课程。返回的课程是按创建时间排序的,最新的课程排在最前面。
此方法会返回以下错误代码:
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
有关详情,请参阅 OAuth 2.0 概览。