Method: courses.patch

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

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

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

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

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