Method: courses.studentGroups.list

Возвращает список групп в курсе.

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

  • NOT_FOUND , если курс не существует.

HTTP-запрос

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

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

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

Параметры
courseId

string

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

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

Параметры
pageSize

integer

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

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

pageToken

string

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

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

previewVersion

enum ( PreviewVersion )

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

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

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

Тело ответа

Ответ при перечислении студенческих групп.

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

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

object ( StudentGroup )

Студенческие группы.

nextPageToken

string

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

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

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

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

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