REST Resource: courses

Recurso: Course

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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
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 após a criação do curso.

Especificar esse campo em uma máscara de atualização de 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-vindos à aula de Biologia do 1º ano do Ensino Médio". 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 usando uma combinação de livros didáticos, palestras de convidados e trabalho de laboratório. Prepare-se para se divertir!" 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 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
  • a string literal "me", que indica 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)

Hora de criação do curso. Especificar esse campo em uma máscara de atualização de 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)

Horário da atualização mais recente deste curso. Especificar esse campo em uma máscara de atualização de 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 de 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. 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 que contém 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 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 participantes do curso podem ver, em que o Google Sala de Aula adiciona eventos para atividades e avisos do curso.

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

Somente leitura.
gradebookSettings

object (GradebookSettings)

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

Somente leitura.
subject

string

Opcional. O assunto do curso.
learningStandardSettings

object (CourseLearningStandardSettings)

Opcional.

Configurações relacionadas aos padrões de aprendizado disponíveis no curso. Um curso pode ter no máximo 20 raízes de repositórios curriculares atribuídas.
levels

string

Opcional. Níveis do curso. Exemplos: "9º ano", "Ensino fundamental", "4º e 5º anos", "Educação infantil ao 2º ano", "3000". Se definido, esse campo precisa ser uma string UTF-8 válida e ter menos de 1.000 caracteres.

Esse campo só pode ser limpo usando o método courses.patch.

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. Não é possível modificá-lo, exceto 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 modificá-lo ou mudar para os estados 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 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 para 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 pelo ownerId pode acessá-lo. 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 aulas, 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 do 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 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Campos
Dados de materiais. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
driveFile

object (DriveFile)

Anexo de arquivo do Google Drive.
youTubeVideo

object (YouTubeVideo)

Anexo de vídeo do YouTube.
form

object (Form)

Anexo do Google Formulários.
Fim dos campos mutuamente exclusivos.

GradebookSettings

As configurações do boletim de notas de um curso. Veja mais detalhes no 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 notas disponíveis para as atividades do curso.

CalculationType

Métodos possíveis de cálculo da nota final.

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

DisplaySetting

Configurações possíveis para mostrar a nota final.

Tipos enumerados
DISPLAY_SETTING_UNSPECIFIED Nenhuma configuração especificada. Isso 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 boletim ou no perfil do estudante.
SHOW_TEACHERS_ONLY Mostra a nota final para os professores no boletim de notas e no perfil do estudante. Oculta do perfil dos estudantes.

CourseLearningStandardSettings

As configurações de padrões de aprendizado de um curso.

Representação JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Campos
standardSets[]

object (LearningStandardSetRoot)

Obrigatório. O conjunto de raízes de padrões de aprendizado aplicadas a este curso.

LearningStandardSetRoot

Representa a raiz de um conjunto selecionado de padrões de aprendizado. Os descendentes das raízes selecionadas vão aparecer ao definir metas de aprendizado em itens do mural na interface do Google Sala de Aula.

Representação JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Campos
caseGuid

object (CaseGuid)

Obrigatório. O GUID do Satchel Rosetta Exchange para uma raiz de repositório curricular.
documentTitle

string

Apenas saída. O título do documento da raiz do repositório curricular.
standardTitle

string

Apenas saída. O título da raiz do repositório curricular.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Apenas saída. O status de disponibilidade da raiz do repositório curricular. Use essa opção para determinar se a raiz do repositório curricular foi excluída da origem.

Métodos

checkAddOnCreationEligibility
(deprecated)

 Informa se um usuário pode criar anexos de complementos em um determinado curso.

checkGradingPeriodsSetupEligibility
(deprecated)

 Informa se um usuário pode atualizar as 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 aos 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.