REST Resource: courses

Recurso: Course

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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
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 sigue asignando el id, que no se puede actualizar después de que se crea el curso.

Si especificas este campo en una máscara de actualización de curso, se producirá 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 puede tener más de 2,800 caracteres.
descriptionHeading

string

Encabezado opcional para la descripción. Por ejemplo, "Te damos la bienvenida a Biología de 10º grado". Si se establece, este campo debe ser una cadena UTF-8 válida y no puede 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 de laboratorio. ¡Prepárate para emocionarte!". Si se establece, este campo debe ser una cadena UTF-8 válida y no puede tener más de 30,000 caracteres.
room

string

Ubicación opcional de la sala. Por ejemplo, "301". Si se establece, este campo debe ser una cadena UTF-8 válida y no puede 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
  • La cadena literal "me", que indica el usuario que realiza la solicitud

Esto se debe establecer 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)

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

Solo lectura.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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)

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

Solo lectura.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. 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 especificas este campo en una máscara de actualización de 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

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

Solo lectura.
courseGroupEmail

string

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

Solo lectura.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Son 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 en este curso.

Solo lectura.
calendarId

string

Es el ID del calendario que pueden ver todos los miembros del curso y al que Classroom agrega eventos para el trabajo de clase y los anuncios del curso.

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)

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

string

Opcional. Es el tema del curso.
learningStandardSettings

object (CourseLearningStandardSettings)

Opcional.

Parámetros de configuración relacionados con los estándares de aprendizaje disponibles en el curso. Un curso puede tener un máximo de 20 raíces de conjuntos de estándares de aprendizaje asignadas.
levels

string

Opcional. Niveles del curso. Ejemplos: "9º grado", "Escuela secundaria", "4º a 5º", "K-2", "3000". Si se establece, este campo debe ser una cadena UTF-8 válida y tener menos de 1,000 caracteres.

Este campo solo se puede borrar con el método courses.patch.

CourseState

Son los estados posibles en los que puede estar un curso.

Enums
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ó. El profesor principal y los administradores del dominio 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 del dominio pueden acceder a él, 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 colocarse en este estado si infringe potencialmente las Condiciones del Servicio.

CourseMaterialSet

Es un conjunto de materiales que aparece en la página "Información" del curso. Estos materiales pueden incluir un programa de asignatura, un cronograma o cualquier otra información de referencia relacionada con el curso en general.

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

string

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 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Campos
Datos de materiales. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
driveFile

object (DriveFile)

Archivo adjunto de Google Drive.
youTubeVideo

object (YouTubeVideo)

Video de YouTube adjunto.
form

object (Form)

Archivo adjunto de Formularios de Google.
Fin de los campos mutuamente excluyentes.

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 que están disponibles para el trabajo de curso en el curso.

CalculationType

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

Enums
CALCULATION_TYPE_UNSPECIFIED No se especificó ningún método. 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 posibles parámetros de configuración para mostrar la calificación general.

Enums
DISPLAY_SETTING_UNSPECIFIED No se especificó ningún parámetro de configuración. 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 su perfil de estudiante.

CourseLearningStandardSettings

Es la configuración de los estándares de aprendizaje de un curso.

Representación JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Campos
standardSets[]

object (LearningStandardSetRoot)

Obligatorio. Es el conjunto de raíces de estándares de aprendizaje que se aplican a este curso.

LearningStandardSetRoot

Representa la raíz de un conjunto seleccionado de estándares de aprendizaje. Los descendientes de las raíces seleccionadas se mostrarán cuando se establezcan objetivos de aprendizaje en los elementos de novedades en la IU de Classroom.

Representación JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Campos
caseGuid

object (CaseGuid)

Obligatorio. Es el GUID de Satchel Rosetta Exchange para la raíz de un conjunto de estándares de aprendizaje.
documentTitle

string

Solo salida. Es el título del documento de la raíz del conjunto de estándares de aprendizaje.
standardTitle

string

Solo salida. Es el título de la raíz del conjunto de estándares de aprendizaje.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Solo salida. Es el estado de disponibilidad de la raíz del conjunto de estándares de aprendizaje. Usa este campo para determinar si se borró de la fuente la raíz del conjunto de estándares de aprendizaje.

Métodos

checkAddOnCreationEligibility
(deprecated)

 Devuelve 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, restringida a aquellos que coinciden con la solicitud.

patch

 Actualiza uno o más campos de un curso.

update

 Actualiza un curso.

updateGradingPeriodSettings

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