REST Resource: courses

Recurso: curso

um curso no Google Sala de Aula.

Representação JSON
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  }
}
Campos
id

string

Identificador deste curso atribuído pelo Google Sala de Aula.

Quando for creating a course, será possível definir esse identificador como alias string na solicitação para criar um alias correspondente. A atividade id ainda será atribuída pelo Google Sala de Aula e não poderá ser atualizada após a criação do curso.

A especificação desse campo em uma máscara de atualização do curso resulta em um erro.

name

string

Nome do curso. Por exemplo, "Biologia do 10o ano". O nome é obrigatório. Ele precisa ter entre 1 e 750 caracteres e uma string UTF-8 válida.

section

string

Seção do curso. Por exemplo, "Período 2". Se definido, esse campo precisa ser uma string UTF-8 válida e não pode ter mais de 2.800 caracteres.

descriptionHeading

string

Título opcional para a descrição. Por exemplo, "Bem-vindo ao 10o ano de Biologia". Se definido, esse campo precisa ser uma string UTF-8 válida e não pode ter mais de 3.600 caracteres.

description

string

Descrição opcional. Por exemplo: "Apreendemos sobre a estrutura de criaturas vivas com uma combinação de livros didáticos, palestras e trabalhos de laboratório. Fique à vontade para se animar!" Se definido, esse campo precisa ser uma string UTF-8 válida e não pode ter mais de 30.000 caracteres.

room

string

Local da sala opcional. Por exemplo, "301". Se definido, esse campo precisa ser uma string UTF-8 válida e não pode ter mais de 650 caracteres.

ownerId

string

O identificador do proprietário de um curso.

Quando especificado como parâmetro de um create course request, esse campo é obrigatório. O identificador pode ser um dos seguintes:

  • o identificador numérico do usuário
  • o endereço de e-mail do usuário
  • o literal de string "me", indicando o usuário solicitante

Isso precisa ser definido em uma solicitação de criação. Os administradores também podem especificar esse campo em uma patch course request para transferir a propriedade. Em outros contextos, ele é somente leitura.

creationTime

string (Timestamp format)

Hora da criação do curso. A especificação desse campo em uma máscara de atualização do curso resulta em um erro.

Somente leitura.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Hora da atualização mais recente deste curso. A especificação desse campo em uma máscara de atualização do curso resulta em um erro.

Somente leitura.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

enrollmentCode

string

Código de inscrição a ser usado para participar deste curso. A especificação desse campo em uma máscara de atualização do curso resulta em um erro.

Somente leitura.

courseState

enum (CourseState)

Estado do curso. Se não for especificado, o estado padrão será PROVISIONED.

teacherGroupEmail

string

O endereço de e-mail de um Grupo do Google com todos os professores do curso. Este grupo não aceita e-mails e só pode ser usado para permissões.

Somente leitura.

courseGroupEmail

string

O endereço de e-mail de um Grupo do Google com todos os participantes do curso. Este grupo não aceita e-mails e só pode ser usado para permissões.

Somente leitura.

teacherFolder

object (DriveFolder)

Informações sobre uma pasta do Google Drive compartilhada com todos os professores do curso.

Este campo só será definido para professores do curso e administradores do domínio.

Somente leitura.

courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Conjuntos de materiais que aparecem na página "Sobre" deste curso.

Somente leitura.

guardiansEnabled

boolean

Se as notificações dos responsáveis estão ativadas ou não para este curso.

Somente leitura.

calendarId

string

O ID da agenda de uma agenda que todos os participantes podem ver e à qual o Google Sala de Aula adiciona eventos de atividades e avisos.

A agenda de um curso é criada de forma assíncrona quando ele é definido como CourseState.ACTIVE pela primeira vez (no momento da criação ou quando ele é atualizado para ACTIVE na interface ou na API). O ID da agenda não será preenchido até que o processo de criação seja concluído.

Somente leitura.

gradebookSettings

object (GradebookSettings)

As configurações do boletim de notas que especificam como a nota final de um estudante do curso vai ser calculada e para quem ela vai ser exibida.

Somente leitura

CourseState

Possíveis estados em que um curso pode estar.

Enums
COURSE_STATE_UNSPECIFIED Nenhum estado do curso. Nenhuma mensagem do curso retornada usará esse valor.
ACTIVE O curso está ativo.
ARCHIVED O curso foi arquivado. Ele não pode ser modificado, mas pode ser alterado para um estado diferente.
PROVISIONED O curso foi criado, mas ainda não foi ativado. Ele pode ser acessado pelo professor principal e pelos administradores do domínio, que podem modificar ou alterar a política para o estado ACTIVE ou DECLINED. Um curso só pode ser alterado para PROVISIONED se estiver no estado DECLINED.
DECLINED O curso foi criado, mas recusado. Ele pode ser acessado pelo proprietário do curso e administradores do domínio, embora não seja exibido na interface da Web. O curso só pode ser modificado para o estado PROVISIONED. Um curso só pode ser alterado para DECLINED se estiver no estado PROVISIONED.
SUSPENDED O curso foi suspenso. Não é possível modificar o curso, e apenas o usuário identificado por ownerId pode visualizá-lo. Um curso pode ser colocado nesse estado se potencialmente violar os Termos de Serviço.

CourseMaterialSet

Um conjunto de materiais que aparece na página "Sobre" do curso. Esses materiais podem incluir um plano de estudos, um cronograma ou outras informações básicas relacionadas ao curso como um todo.

Representação JSON
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Campos
title

string

Título deste conjunto.

materials[]

object (CourseMaterial)

Materiais anexados a este conjunto.

CourseMaterial

Um material anexado a um curso como parte de um conjunto de materiais.

Representação JSON
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
Campos
Campo de união material. Dados do Material Design. material pode ser apenas de um dos tipos a seguir:
driveFile

object (DriveFile)

Anexo de arquivo do Google Drive.

youTubeVideo

object (YouTubeVideo)

Anexo de vídeo do YouTube.

form

object (Form)

Anexo do app Formulários Google.

GradebookSettings

As configurações do boletim de notas de um curso. Consulte o artigo da Central de Ajuda para saber mais detalhes.

Representação JSON
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Campos
calculationType

enum (CalculationType)

Indica como a nota final é calculada.

displaySetting

enum (DisplaySetting)

Indica quem pode ver a nota final.

gradeCategories[]

object (GradeCategory)

Categorias de notas disponíveis para as atividades do curso.

CalculationType

Métodos possíveis para calcular a nota final.

Enums
CALCULATION_TYPE_UNSPECIFIED Nenhum método especificado. Nunca é retornado.
TOTAL_POINTS A nota final é a soma das notas dividida pela soma dos pontos totais, independentemente da categoria.
WEIGHTED_CATEGORIES A nota final é a média ponderada por categoria.

DisplaySetting

Possíveis configurações para exibir a nota final.

Enums
DISPLAY_SETTING_UNSPECIFIED Nenhuma configuração especificada. Nunca é retornado.
SHOW_OVERALL_GRADE Mostra a nota final no boletim de notas e no perfil do estudante para professores e estudantes.
HIDE_OVERALL_GRADE Não mostra a nota final no diário de classe ou no perfil do estudante.
SHOW_TEACHERS_ONLY Mostra a nota final para os professores no diário de classe e no perfil dos alunos. Oculta dos estudantes no perfil de estudante.

Métodos

checkAddOnCreationEligibility

Retorna se um usuário está qualificado para criar anexos de complementos em um determinado curso.

create

Cria um curso.

delete

Exclui um curso.

get

Retorna um curso.

list

Retorna uma lista de cursos que o usuário solicitante tem permissão para ver, restritos àqueles que correspondem à solicitação.

patch

Atualiza um ou mais campos em um curso.

update

Atualiza um curso.