Method: courses.studentGroups.studentGroupMembers.list

Возвращает список студентов, входящих в группу.

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

  • Если курс или группа студентов не существуют, NOT_FOUND .

HTTP-запрос

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers

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

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

Параметры
courseId

string

Обязательно. Идентификатор курса.

studentGroupId

string

Обязательно. Идентификатор студенческой группы.

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

Параметры
pageSize

integer

Максимальное количество возвращаемых элементов. Ноль или неуказанное значение означает, что сервер может установить максимальное количество.

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

pageToken

string

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

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

previewVersion

enum ( PreviewVersion )

Необязательно. Предварительная версия API. Необходимо указать этот параметр для доступа к новым возможностям API, предоставляемым разработчикам в рамках программы предварительного просмотра.

Текст запроса

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

Ответный текст

Ответ при составлении списка студентов в группе.

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

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

object ( StudentGroupMember )

Члены студенческой группы.

nextPageToken

string

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

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

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