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 que asigna Classroom.

Cuando creating a course, puedes establecer este identificador de forma opcional en un alias string en la solicitud para crear un alias correspondiente. Classroom sigue asignando el id y no se puede actualizar después de que se crea el curso.

Si se especifica este campo en una máscara de actualización del curso, se producirá un error.
name

string

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 configura, este campo debe ser una cadena UTF-8 válida y no debe superar los 2,800 caracteres.
descriptionHeading

string

Es el encabezado opcional para la descripción. Por ejemplo, “Bienvenido a la clase de biología de 10º grado”. Si se configura, este campo debe ser una cadena UTF-8 válida y no debe superar los 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, clases magistrales y trabajo de laboratorio. ¡Prepárense para emocionarse!". Si se configura, este campo debe ser una cadena UTF-8 válida y no debe superar los 30,000 caracteres.
room

string

Ubicación de la habitación opcional. Por ejemplo, "301". Si se configura, este campo debe ser una cadena UTF-8 válida y no debe superar los 650 caracteres.
ownerId

string

Es el identificador del propietario de un curso.

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

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

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

string (Timestamp format)

Es la fecha y hora de creación del curso. Si se especifica este campo en una máscara de actualización del curso, se producirá un error.

Solo lectura.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Fecha y hora de la actualización más reciente de este curso. Si se especifica este campo en una máscara de actualización del curso, se producirá un error.

Solo lectura.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Es el código de inscripción que se debe usar para unirse a este curso. Si se especifica este campo en una máscara de actualización del curso, se producirá un error.

Solo lectura.
courseState

enum (CourseState)

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

string

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 permisos.

Solo lectura.
courseGroupEmail

string

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 permisos.

Solo lectura.
teacherFolder

object (DriveFolder)

Es 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 del dominio.

Solo lectura.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Son los conjuntos de materiales que aparecen en la página "Acerca de" de este curso.

Solo lectura.
guardiansEnabled

boolean

Indica si las notificaciones para tutores están habilitadas para este curso.

Solo lectura.
calendarId

string

Es el ID de un calendario que pueden ver todos los miembros del curso y 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 completará hasta que finalice el proceso de creación.

Solo lectura.
gradebookSettings

object (GradebookSettings)

Son los parámetros de configuración del libro de calificaciones que especifican 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 en los que puede encontrarse un curso.

Enumeraciones
COURSE_STATE_UNSPECIFIED No hay estado del curso. Ningún mensaje de Course devuelto usará este valor.
ACTIVE El curso está activo.
ARCHIVED Se archivó el curso. No puedes modificarlo, excepto para cambiarlo a un estado diferente.
PROVISIONED Se creó el curso, pero aún no se activó. Pueden acceder a él el profesor principal y los administradores del dominio, quienes pueden 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ó. Pueden acceder a él el propietario del curso y los administradores del dominio, 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 ownerId puede verlo. Un curso puede colocarse en este estado si potencialmente incumple 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 programa de estudios, un cronograma o cualquier otra información general 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. Son los datos de los materiales. Las direcciones (material) solo pueden ser una de las siguientes opciones:
driveFile

object (DriveFile)

Es un archivo adjunto de Google Drive.
youTubeVideo

object (YouTubeVideo)

Es un archivo adjunto de video de YouTube.
form

object (Form)

Es un archivo adjunto de Formularios de Google.

GradebookSettings

Es la configuración del libro de calificaciones de un curso. Consulta el artículo del Centro de ayuda para obtener más detalles.

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 disponibles para el trabajo del curso.

CalculationType

Son los métodos posibles para calcular la calificación general.

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

DisplaySetting

Son los parámetros de configuración posibles para mostrar la calificación general.

Enumeraciones
DISPLAY_SETTING_UNSPECIFIED No se especificó ningún parámetro de configuración. Este valor nunca se devuelve.
SHOW_OVERALL_GRADE Muestra la calificación general en el libro de calificaciones y el perfil del estudiante tanto a los profesores como a los estudiantes.
HIDE_OVERALL_GRADE No se 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 de los estudiantes en sus perfiles.

Métodos

checkAddOnCreationEligibility
(deprecated)

 Devuelve un valor que indica si un usuario es apto para crear archivos adjuntos de complementos en un curso determinado.

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

 Crea un curso.

delete

 Borra un curso.

get

 Devuelve un curso.

getGradingPeriodSettings

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

list

 Devuelve una lista de los cursos que el usuario solicitante tiene permiso para ver, restringidos 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.