Method: courses.list

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

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

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

HTTP-запрос

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

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

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

Параметры
studentId

string

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

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

Если указано, teacherId должно быть пустым.

teacherId

string

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

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

Если указано, studentId должно быть пустым.

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

Для получения более подробной информации см. руководство по авторизации .