Method: courses.patch

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

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

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

HTTP-запрос

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

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

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

Параметры
id

string

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

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

Параметры
updateMask

string ( FieldMask format)

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

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

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

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

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

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

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

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

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

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

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

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

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

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