Method: courses.patch

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

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

  • PERMISSION_DENIED если запрашивающему пользователю не разрешено изменять запрашиваемый курс или возникли ошибки доступа .
  • NOT_FOUND , если курса с запрошенным идентификатором не существует.
  • INVALID_ARGUMENT , если в маске обновления указаны недопустимые поля или если маска обновления не указана.
  • FAILED_PRECONDITION для следующих ошибок запроса :
    • КурсНеИзменяемый
    • НеактивныйВладелецКурса
    • НеправомочныйВладелец
    • CourseTitleCannotContainUrl

HTTP-запрос

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

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

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

Параметры
id

string

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

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

Параметры
updateMask

string ( FieldMask format)

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

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

Примечание: исправления для ownerId считаются вступающими в силу немедленно, но на практике для завершения передачи прав собственности на все затронутые ресурсы может потребоваться некоторое время.

При установке в параметре запроса это поле должно быть указано как

updateMask=<field1>,<field2>,...

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

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

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

Тело ответа

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

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

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

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

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