Method: courses.studentGroups.patch

Atualiza um ou mais campos em um grupo de estudantes.

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 grupo de estudantes solicitado ou por erros de acesso.
  • NOT_FOUND se o grupo de estudantes não existir ou se o usuário não tiver acesso a ele.
  • INVALID_ARGUMENT se campos inválidos forem especificados na máscara de atualização ou se nenhuma máscara de atualização for fornecida.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
courseId

string

Obrigatório. Identificador do curso.
id

string

Obrigatório. Identificador do grupo de estudantes.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Obrigatório. Máscara que identifica quais campos do grupo de estudantes serão atualizados. Este campo é obrigatório para fazer uma atualização. A atualização falha se campos inválidos forem especificados.

Os professores podem especificar os seguintes campos:

  • title

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

enum (PreviewVersion)

Opcional. A versão de prévia do endpoint. Isso precisa ser definido para acessar os novos recursos de API disponibilizados aos desenvolvedores no programa de prévia.

Corpo da solicitação

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

Corpo da resposta

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

Escopos de autorização

Requer o seguinte escopo OAuth:

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

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