Method: courses.studentGroups.patch

Обновляет одно или несколько полей в группе студентов.

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

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

HTTP-запрос

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

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

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

Параметры
courseId

string

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

id

string

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

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

Параметры
updateMask

string ( FieldMask format)

Обязательно. Маска, определяющая, какие поля в группе студентов необходимо обновить. Это поле обязательно для обновления. Обновление завершится ошибкой, если указаны недопустимые поля.

Преподаватели могут указать следующие поля:

  • title

Это список полных имён полей, разделённых запятыми. Пример: "user.displayName,photo" .

previewVersion

enum ( PreviewVersion )

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

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

Тело запроса содержит экземпляр StudentGroup .

Тело ответа

В случае успеха тело ответа содержит экземпляр StudentGroup .

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

Требуется следующая область OAuth:

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

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