Method: courses.students.list

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

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

HTTP-запрос

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

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

Параметры пути

Параметры
courseId

string

Идентификатор курса. Этот идентификатор может быть либо идентификатором, присвоенным Классом, либо alias .

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

Параметры
pageSize

integer

Максимальное количество товаров для возврата. Значение по умолчанию — 30, если не указано, или 0 .

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

pageToken

string

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

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

Тело запроса

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

Тело ответа

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

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

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

object ( Student )

Учащиеся, соответствующие запросу списка.

nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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