REST Resource: courses

Recurso: Curso

Un curso en Classroom

Representación 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

Es el identificador de este curso asignado por Classroom.

Cuando creating a course, puedes establecer este identificador en un alias string en la solicitud para crear un alias correspondiente. Classroom todavía asigna id y no se puede actualizar después de crear el curso.

Especificar este campo en una máscara de actualización del curso da como resultado un error.
name

string

Es el nombre del curso. Por ejemplo, “Biología de 10º grado”. El nombre es obligatorio. Debe tener entre 1 y 750 caracteres y ser una cadena UTF-8 válida.
section

string

Sección del curso. Por ejemplo, "Período 2". Si se establece, este campo debe ser una cadena UTF-8 válida y no debe tener más de 2,800 caracteres.
descriptionHeading

string

Encabezado opcional para la descripción. Por ejemplo, “Bienvenidos al curso de Biología de 10° grado”. Si se configura, este campo debe ser una string UTF-8 válida y no debe tener más de 3,600 caracteres.
description

string

Descripción opcional. Por ejemplo, "Aprenderemos sobre la estructura de los seres vivos a partir de una combinación de libros de texto, conferencias de invitados y trabajo en el laboratorio. Te sorprenderá". Si se establece, este campo debe ser una cadena UTF-8 válida y no debe tener más de 30,000 caracteres.
room

string

Ubicación de la habitación opcional. Por ejemplo, “301”. Si se establece, este campo debe ser una cadena UTF-8 válida y no debe tener más de 650 caracteres.
ownerId

string

Es el identificador del propietario de un curso.

Cuando se especifica como un parámetro de un create course request, este campo es obligatorio. El identificador puede ser uno de los siguientes:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me", que indica el usuario solicitante

Esto se debe configurar en una solicitud de creación. Los administradores también pueden especificar este campo en un patch course request para transferir la propiedad. En otros contextos, es de solo lectura.
creationTime

string (Timestamp format)

Hora de creación del curso. Si especificas este campo en una máscara de actualización de cursos, se producirá un error.

Solo lectura.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Es la hora de la actualización más reciente de este curso. Si especificas este campo en una máscara de actualización de cursos, se producirá un error.

Solo lectura.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

Es el código de inscripción que debes usar cuando te unas a este curso. Si especificas este campo en una máscara de actualización de cursos, se producirá un error.

Solo lectura.
courseState

enum (CourseState)

Estado del curso. Si no se especifica, el estado predeterminado es PROVISIONED.
teacherGroupEmail

string

La dirección de correo electrónico de un Grupo de Google que contiene a todos los profesores del curso. Este grupo no acepta correos electrónicos y solo se puede usar para los permisos.

Solo lectura.
courseGroupEmail

string

La dirección de correo electrónico de un Grupo de Google que contiene a todos los miembros del curso. Este grupo no acepta correos electrónicos y solo se puede usar para los permisos.

Solo lectura.
teacherFolder

object (DriveFolder)

Información sobre una carpeta de Drive que se comparte con todos los profesores del curso.

Este campo solo se establecerá para los profesores del curso y los administradores de dominios.

Solo lectura.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Conjuntos de materiales que aparecen en la página “Acerca de” de este curso.

Solo lectura.
guardiansEnabled

boolean

Si las notificaciones para tutores están habilitadas o no para este curso

Solo lectura.
calendarId

string

El ID de calendario de un calendario que pueden ver todos los miembros del curso, al que Classroom agrega eventos para el trabajo del curso y los anuncios en él.

El calendario de un curso se crea de forma asíncrona cuando el curso se establece en CourseState.ACTIVE por primera vez (en el momento de la creación o cuando se actualiza a ACTIVE a través de la IU o la API). El ID del calendario no se propagará hasta que se complete el proceso de creación.

Solo lectura.
gradebookSettings

object (GradebookSettings)

La configuración del libro de calificaciones que especifica cómo se calculará la calificación general de un estudiante para el curso y a quién se le mostrará.

Solo lectura

CourseState

Son los estados posibles de un curso.

Enumeraciones
COURSE_STATE_UNSPECIFIED No hay estado del curso. Ningún mensaje del curso que se devuelva usará este valor.
ACTIVE El curso está activo.
ARCHIVED Se archivó el curso. Solo puedes modificarlo para cambiarlo a un estado diferente.
PROVISIONED Se creó el curso, pero aún no se activó. El profesor principal y los administradores de dominios pueden acceder a él y modificarlo o cambiarlo a los estados ACTIVE o DECLINED. Un curso solo se puede cambiar a PROVISIONED si está en el estado DECLINED.
DECLINED Se creó el curso, pero se rechazó. El propietario del curso y los administradores de dominios pueden acceder a ella, aunque no se mostrará en la IU web. No puedes modificar el curso, excepto para cambiarlo al estado PROVISIONED. Un curso solo se puede cambiar a DECLINED si está en el estado PROVISIONED.
SUSPENDED Se suspendió el curso. No puedes modificar el curso, y solo el usuario identificado por el ownerId puede verlo. Un curso puede estar en este estado si es posible que incumpla las Condiciones del Servicio.

CourseMaterialSet

Es un conjunto de materiales que aparece en la página "Acerca de" del curso. Estos materiales pueden incluir un plan de estudios, un cronograma o cualquier otra información de referencia relacionada con el curso en su totalidad.

Representación JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Campos
title

string

Es el título de este conjunto.
materials[]

object (CourseMaterial)

Son los materiales adjuntos a este conjunto.

CourseMaterial

Es un material adjunto a un curso como parte de un conjunto de materiales.

Representación 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ón material. Datos de Material. Las direcciones (material) solo pueden ser una de las siguientes opciones:
driveFile

object (DriveFile)

Archivo adjunto de Google Drive
youTubeVideo

object (YouTubeVideo)

Archivo de video de YouTube adjunto.
form

object (Form)

Archivo adjunto de Formularios de Google.

GradebookSettings

La configuración del libro de calificaciones de un curso. Para obtener más detalles, consulta el artículo del Centro de ayuda.

Representación JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Campos
calculationType

enum (CalculationType)

Indica cómo se calcula la calificación general.
displaySetting

enum (DisplaySetting)

Indica quién puede ver la calificación general.
gradeCategories[]

object (GradeCategory)

Son las categorías de calificación que están disponibles para las tareas del curso.

CalculationType

Posibles métodos de cálculo de la calificación general.

Enumeraciones
CALCULATION_TYPE_UNSPECIFIED No se especificó ningún método. Este valor nunca se muestra.
TOTAL_POINTS La calificación general es la suma de las calificaciones dividida por la suma del total de puntos, independientemente de la categoría.
WEIGHTED_CATEGORIES La calificación general es el promedio ponderado por categoría.

DisplaySetting

Posibles parámetros de configuración para mostrar la calificación general.

Enumeraciones
DISPLAY_SETTING_UNSPECIFIED No se especificó ningún parámetro de configuración. Este valor nunca se muestra.
SHOW_OVERALL_GRADE Muestra la calificación general en el libro de calificaciones y el perfil del estudiante a los profesores y estudiantes.
HIDE_OVERALL_GRADE No muestra la calificación general en el libro de calificaciones ni en el perfil del estudiante.
SHOW_TEACHERS_ONLY Muestra la calificación general a los profesores en el libro de calificaciones y el perfil del estudiante. Se oculta a los estudiantes en sus perfiles.

Métodos

checkAddOnCreationEligibility
(deprecated)

 Muestra si un usuario es apto para crear archivos adjuntos de complementos en un curso determinado.

checkGradingPeriodsSetupEligibility
(deprecated)

 Muestra si un usuario es apto para actualizar GradingPeriodSettings en un curso determinado.

create

 Crea un curso.

delete

 Borra un curso.

get

 Muestra un curso.

getGradingPeriodSettings

 Devuelve la configuración del período de calificación de un curso.

list

 Muestra una lista de cursos que el usuario solicitante puede ver, restringida a los que coinciden con la solicitud.

patch

 Actualiza uno o más campos en un curso.

update

 Actualiza un curso.

updateGradingPeriodSettings

 Actualiza la configuración del período de calificación de un curso.