Method: courses.list

Возвращает список курсов, которые разрешено просматривать запрашивающему пользователю, ограниченный теми, которые соответствуют запросу. Возвращенные курсы упорядочены по времени создания, причем первыми идут самые последние созданные.

Этот метод возвращает следующие коды ошибок:

  • PERMISSION_DENIED для ошибок доступа .
  • INVALID_ARGUMENT если аргумент запроса имеет неверный формат.
  • NOT_FOUND если какие-либо пользователи, указанные в аргументах запроса, не существуют.

HTTP-запрос

GET https://classroom.googleapis.com/v1/courses

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
studentId

string

Ограничивает возвращаемые курсы теми, у кого есть студент с указанным идентификатором. Идентификатор может быть одним из следующих:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий запрашивающего пользователя
teacherId

string

Ограничивает возвращаемые курсы теми, у кого есть преподаватель с указанным идентификатором. Идентификатор может быть одним из следующих:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий запрашивающего пользователя
courseStates[]

enum ( CourseState )

Ограничивает возвращаемые курсы курсами, находящимися в одном из указанных состояний. Значение по умолчанию: АКТИВНО, АРХИВИРОВАНО, ПРЕДОСТАВЛЕНО, ОТКЛОНЕНО.

pageSize

integer

Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум.

Сервер может вернуть меньшее количество результатов, чем указано.

pageToken

string

Значение nextPageToken , возвращенное из предыдущего вызова list , указывает, что должна быть возвращена следующая страница результатов.

В остальном запрос list должен быть идентичен тому, который привел к получению этого токена.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ при перечислении курсов.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Поля
courses[]

object ( Course )

Курсы, соответствующие запросу списка.

nextPageToken

string

Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Дополнительную информацию см. в руководстве по авторизации .