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, você pode definir esse identificador como um alias string na solicitação para criar um alias correspondente. A atividade id é atribuída pelo Google Sala de Aula e não pode ser atualizada 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 10º 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

Cabeçalho 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 de criaturas vivas por meio de uma combinação de livros didáticos, palestras de convidados e trabalhos de laboratório. Espero que você esteja animado!" 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 do quarto 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 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)

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

Somente leitura.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", 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. Especificar esse campo em uma máscara de atualização de curso resulta em um erro.

Somente leitura.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", 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 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. Esse grupo não aceita e-mail 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 membros do curso. Este grupo não aceita e-mail 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 os 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

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

Somente leitura.
calendarId

string

O ID da agenda que todos os participantes do curso podem acessar e onde o Google Sala de Aula adiciona eventos de trabalhos e avisos.

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 API). O ID do calendário não será preenchido até que o processo de criação seja concluído.

Somente leitura.
gradebookSettings

object (GradebookSettings)

As configurações da plataforma de boletim de notas que especificam como a nota geral de um estudante para o curso será calculada e para quem ela será exibida.

Somente leitura

CourseState

Estados possíveis de um curso.

Enums
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 alterá-lo para um estado diferente.
PROVISIONED O curso foi criado, mas ainda não foi ativado. Ele é acessível pelo professor principal e pelos administradores de 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 é acessível pelo proprietário do curso e pelos administradores de domínio, mas não é exibido 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 aula, 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. 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 da planilha de notas de um curso. Consulte o artigo da Central de Ajuda para mais detalhes.

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

enum (CalculationType)

Indica como a nota geral é calculada.
displaySetting

enum (DisplaySetting)

Indica quem pode ver a nota final.
gradeCategories[]

object (GradeCategory)

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

CalculationType

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

Enums
CALCULATION_TYPE_UNSPECIFIED Nenhum método especificado. Isso nunca é retornado.
TOTAL_POINTS A nota final é a soma das notas dividida pelo total de pontos, independente da categoria.
WEIGHTED_CATEGORIES A nota final é a média ponderada por categoria.

DisplaySetting

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

Enums
DISPLAY_SETTING_UNSPECIFIED Nenhuma configuração especificada. Ele 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 aos professores no boletim de notas e no perfil do aluno. Oculta o conteúdo para os estudantes no perfil deles.

Métodos

checkAddOnCreationEligibility
(deprecated)

 Retorna se um usuário tem direito de criar anexos de complementos em um determinado curso.

checkGradingPeriodsSetupEligibility
(deprecated)

 Retorna se um usuário está qualificado para atualizar as configurações de período de avaliação 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.