REST Resource: courses

Recurso: Curso

Un curso en el aula.

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

Identificador de este curso asignado por Classroom.

Al creating a course , puede configurar opcionalmente este identificador en una alias string en la solicitud para crear un alias correspondiente. Classroom aún asigna la id y no se puede actualizar después de crear el curso.

Especificar este campo en una máscara de actualización de curso genera un error.

name

string

Nombre del curso. Por ejemplo, "Biología de grado 10". El nombre es obligatorio. Debe tener entre 1 y 750 caracteres y 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 más de 2800 caracteres.

descriptionHeading

string

Encabezado opcional para la descripción. Por ejemplo, "Bienvenido a Biología de 10.º grado". Si se establece, este campo debe ser una cadena UTF-8 válida y no más de 3600 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. ¡Espera estar emocionado!" Si se establece, este campo debe ser una cadena UTF-8 válida y no 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 más de 650 caracteres.

ownerId

string

El identificador del propietario de un curso.

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

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

Esto debe establecerse en una solicitud de creación. Los administradores también pueden especificar este campo en una patch course request para transferir la propiedad. En otros contextos, es de sólo lectura.

creationTime

string ( Timestamp format)

Hora de creación del curso. Especificar este campo en una máscara de actualización de curso genera un error.

Solo lectura.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con 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)

Hora de la actualización más reciente de este curso. Especificar este campo en una máscara de actualización de curso genera un error.

Solo lectura.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con 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

Código de inscripción para usar al unirse a este curso. Especificar este campo en una máscara de actualización de curso genera 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 correo electrónico y solo se puede usar para obtener 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 correo electrónico y solo se puede usar para obtener 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 )

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 para un calendario que todos los miembros del curso pueden ver, al que Classroom agrega eventos para el trabajo del curso y anuncios en el curso.

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

estado del curso

Posibles estados en los que puede estar un curso.

Enumeraciones
COURSE_STATE_UNSPECIFIED Sin estado del curso. Ningún mensaje de curso devuelto utilizará este valor.
ACTIVE El curso está activo.
ARCHIVED El curso ha sido archivado. No puede modificarlo excepto para cambiarlo a un estado diferente.
PROVISIONED El curso ha sido creado, pero aún no está activado. Es accesible para el maestro 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 se encuentra en estado DECLINED .
DECLINED El curso ha sido creado, pero rechazado. Es accesible para el propietario del curso y los administradores del dominio, aunque no se mostrará en la interfaz de usuario web. No puede modificar el curso excepto para cambiarlo al estado PROVISIONED . Un curso solo se puede cambiar a DECLINED si se encuentra en el estado PROVISIONED .
SUSPENDED El curso ha sido suspendido. No puede modificar el curso y solo el usuario identificado por el ownerId de propietario puede ver el curso. Un curso puede colocarse en este estado si potencialmente viola los Términos de servicio.

CursoMaterialConjunto

Un conjunto de materiales que aparece en la página "Acerca de" del curso. Estos materiales pueden incluir un plan de estudios, un programa u otra información general relacionada con el curso en su totalidad.

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

string

Título para este conjunto.

materials[]

object ( CourseMaterial )

Materiales adjuntos a este conjunto.

Material del curso

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
material de campo de unión. Datos materiales. El material puede ser solo uno de los siguientes:
driveFile

object ( DriveFile )

Archivo adjunto de Google Drive.

youTubeVideo

object ( YouTubeVideo )

Adjunto de vídeo de Youtube.

form

object ( Form )

Archivo adjunto de formularios de Google.

Configuración del libro de calificaciones

La configuración del libro de calificaciones para un curso. Consulte 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 )

Categorías de calificación que están disponibles para el trabajo de curso en el curso.

Tipo de cálculo

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

Enumeraciones
CALCULATION_TYPE_UNSPECIFIED No se especifica ningún método. Esto 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.

Configuración de pantalla

Posibles configuraciones para mostrar la calificación general.

Enumeraciones
DISPLAY_SETTING_UNSPECIFIED No se ha especificado ningún ajuste. Esto nunca se devuelve.
SHOW_OVERALL_GRADE Muestra la calificación general en el libro de calificaciones y el perfil del estudiante tanto para los maestros como para los 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 maestros en el libro de calificaciones y el perfil del estudiante. Se oculta de los estudiantes en su perfil de estudiante.

Métodos

create

Crea un curso.

delete

Elimina un curso.

get

Devuelve un curso.

list

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

patch

Actualiza uno o más campos en un curso.

update

Actualiza un curso.