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 do curso atribuído pelo Google Sala de Aula.

Quando creating a course, é possível definir esse identificador como um alias string na solicitação para criar um alias correspondente. O id ainda é atribuído pelo Google Sala de Aula e não pode ser atualizado depois que o curso é criado.

Especificar esse campo em uma máscara de atualização do curso resulta em um erro.
name

string

Nome do curso. Por exemplo, "Biologia do 1º ano do ensino médio". O nome é obrigatório. Ele precisa ter entre 1 e 750 caracteres e ser 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 à Biologia do 10º ano". 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: "Vamos aprender sobre a estrutura dos seres vivos com uma combinação de livros didáticos, palestras de convidados e trabalho de laboratório. Você vai se divertir muito!" Se definido, esse campo precisa ser uma string UTF-8 válida e não pode ter mais de 30.000 caracteres.
room

string

Localização opcional da sala. 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 um 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 um patch course request para transferir a propriedade. Em outros contextos, ele é somente leitura.
creationTime

string (Timestamp format)

Horário de criação do curso. Especificar esse campo em uma máscara de atualização do curso resulta em um erro.

Somente leitura.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Data e hora da atualização mais recente deste curso. Especificar esse campo em uma máscara de atualização do curso resulta em um erro.

Somente leitura.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Código de inscrição para usar ao participar deste curso. Especificar esse 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 que contém todos os professores do curso. Esse 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 que contém todos os participantes do curso. Esse 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 Drive compartilhada com todos os professores do curso.

Esse 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 para responsáveis estão ativadas para este curso.

Somente leitura.
calendarId

string

O ID de uma agenda que todos os membros do curso podem acessar e em que o Google Sala de Aula adiciona eventos de atividades e avisos do curso.

O Google Agenda de um curso é criado de forma assíncrona quando o curso é definido como CourseState.ACTIVE pela primeira vez (na criação ou quando é atualizado para ACTIVE pela interface ou pela API). O ID do Google 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 que especificam como a nota geral de um estudante no curso será calculada e para quem ela será mostrada.

Somente leitura

CourseState

Possíveis estados de um curso.

Tipos enumerados
COURSE_STATE_UNSPECIFIED Nenhum estado do curso. Nenhuma mensagem de curso retornada vai usar esse valor.
ACTIVE O curso está ativo.
ARCHIVED O curso foi arquivado. Ele não pode ser modificado, a não ser para mudar 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 mudar para os estados ACTIVE ou DECLINED. Um curso só pode ser mudado para PROVISIONED se estiver no estado DECLINED.
DECLINED O curso foi criado, mas recusado. Ele pode ser acessado pelo proprietário do curso e pelos administradores do domínio, mas não aparece na interface da Web. Não é possível modificar o curso, exceto para mudar o estado dele para PROVISIONED. Um curso só pode ser mudado 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 pelo ownerId pode acessar o conteúdo. Um curso pode ser colocado nesse estado se 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 gerais 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 de material. 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 Formulários Google.

GradebookSettings

As configurações do boletim de um curso. Confira mais detalhes neste artigo da Central de Ajuda.

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 nota disponíveis para atividades do curso.

CalculationType

Possíveis métodos de cálculo da nota final.

Tipos enumerados
CALCULATION_TYPE_UNSPECIFIED Nenhum método especificado. Esse valor nunca é retornado.
TOTAL_POINTS A nota final é a soma das notas dividida pela soma do total de pontos, independente da categoria.
WEIGHTED_CATEGORIES A nota final é a média ponderada por categoria.

DisplaySetting

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

Tipos enumerados
DISPLAY_SETTING_UNSPECIFIED Nenhuma configuração especificada. Esse valor nunca é retornado.
SHOW_OVERALL_GRADE Mostra a nota final no diário de classe 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 do estudante. Fica oculto dos estudantes no perfil deles.

Métodos

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

 Retorna se um usuário está qualificado para atualizar "GradingPeriodSettings" em um determinado curso.

create

 Cria um curso.

delete

 Exclui um curso.

get

 Retorna um curso.

getGradingPeriodSettings

 Retorna as configurações do período de avaliação em um curso.

list

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

patch

 Atualiza um ou mais campos em um curso.

update

 Atualiza um curso.

updateGradingPeriodSettings

 Atualiza as configurações do período de avaliação de um curso.