Seus usuários usam o Google Sala de Aula com o Google Meet? Confira o guia de início rápido do Apps Script que mostra como verificar a participação dos alunos nos cursos do Google Meet.

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)
  }
}
Campos
id

string

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

Quando creating a course, você tem a opção de 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 do curso resulta em erro.
name

string

Nome do curso. Por exemplo, "Biologia do 1o 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, este 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 10o ano". Se definido, este 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 das criaturas vivas com uma combinação de livros didáticos, palestras e trabalhos em laboratório. Estamos animados!" Se definido, este 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, este 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, este 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 que 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 da criação do curso. Especificar esse campo em uma máscara de atualização do curso resulta em 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. Especificar esse campo em uma máscara de atualização do curso resulta em 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 ao participar deste curso. Especificar esse campo em uma máscara de atualização do curso resulta em 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 membros 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 que é compartilhada com todos os professores do curso.

Este campo só será definido para os professores do curso e dos 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 os responsáveis estão ativadas neste curso.

Somente leitura.
calendarId

string

O código da agenda que todos os membros do curso podem ver, ao qual o Google Sala de aula adiciona eventos para os trabalhos 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 ele é atualizado para ACTIVE por meio da IU ou da 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 diário de classe que especificam como a nota final de um aluno no curso será calculada e para quem ele será exibido.

Somente leitura

Curso

Possíveis estados dos cursos.

Enums
COURSE_STATE_UNSPECIFIED Nenhum estado do curso. Nenhuma mensagem retornada do curso usará esse valor.
ACTIVE O curso está ativo.
ARCHIVED O curso foi arquivado. Não é possível modificá-lo, exceto alterá-lo para um estado diferente.
PROVISIONED O curso foi criado, mas ainda não foi ativado. Ele pode ser acessado pelos professores principais e administradores do domínio, que podem modificá-la ou mudá-la para os estados ACTIVE ou DECLINED. Um curso só poderá 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, embora não seja exibido na IU da Web. Não é possível modificar o curso, exceto alterá-lo para o estado PROVISIONED. Um curso só poderá 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 vê-lo. Um curso poderá ser colocado nesse estado se ele violar os Termos de Serviço.

Conjunto de materiais do curso

Um conjunto de materiais que é exibido na página "Sobre" do curso. Esses materiais podem incluir um plano de aulas, uma programação ou outras informações contextuais relacionadas ao curso como um todo.

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

string

Título desse conjunto.
materials[]

object (CourseMaterial)

Materiais anexados a este conjunto.

Material do curso

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.

Configurações do diário de classe

As configurações do diário de classe 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 final é calculada.
displaySetting

enum (DisplaySetting)

Indica quem pode ver a nota final.
gradeCategories[]

object (GradeCategory)

Categorias de notas que estão disponíveis para as atividades do curso.

Tipo de cálculo

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

Enums
CALCULATION_TYPE_UNSPECIFIED Nenhum método especificado. Ela nunca é retornada.
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.

Configuração de exibição

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

Enums
DISPLAY_SETTING_UNSPECIFIED Nenhuma configuração especificada. Ela nunca é retornada.
SHOW_OVERALL_GRADE Mostra a nota final do diário de classe e do perfil dos alunos para os professores e os alunos.
HIDE_OVERALL_GRADE Não mostra a nota final no diário de classe ou no perfil do aluno.
SHOW_TEACHERS_ONLY Mostra a nota final para os professores no diário de classe e no perfil dos alunos. Oculta dos alunos no perfil deles.

Métodos

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 visualizar, restritos àqueles que correspondem à solicitação.

patch

 Atualiza um ou mais campos em um curso.

update

 Atualiza um curso.