Method: courses.patch

Atualiza um ou mais campos em um curso.

Esse método retorna os seguintes códigos de erro:

  • PERMISSION_DENIED se o usuário solicitante não tiver permissão para modificar o curso solicitado ou por erros de acesso.
  • NOT_FOUND se não houver um curso com o ID solicitado.
  • INVALID_ARGUMENT se campos inválidos forem especificados na máscara de atualização ou se nenhuma máscara de atualização for fornecida.
  • FAILED_PRECONDITION para os seguintes erros de solicitação:
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner
    • CourseTitleCannotContainUrl

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
id

string

Identificador do curso a ser atualizado. Esse identificador pode ser o atribuído pelo Google Sala de Aula ou um alias.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Máscara que identifica quais campos do curso serão atualizados. Este campo é obrigatório para fazer uma atualização. A atualização vai falhar se campos inválidos forem especificados. Os seguintes campos são válidos:

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

Observação: os patches para "ownerId" são tratados como efetivos imediatamente, mas, na prática, pode levar algum tempo para que a transferência de propriedade de todos os recursos afetados seja concluída.

Quando definido em um parâmetro de consulta, esse campo precisa ser especificado como

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

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

O corpo da solicitação contém uma instância de Course.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Course.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o guia de autorização.