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 es creating a course, puedes configurar de manera opcional este identificador en un alias string en la solicitud para crear un alias correspondiente. Classroom aún está asignado a id y no se puede actualizar después de que se crea el curso.

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

string

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

string

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

string

Encabezado opcional para la descripción. Por ejemplo, "Te damos la bienvenida a 10o grado de biología". 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 las criaturas vivas a partir de una combinación de libros de texto, conferencias invitadas y trabajos de laboratorio. Es esperable. Si se configura, este campo debe ser una string UTF-8 válida y no debe tener más de 30,000 caracteres.
room

string

Ubicación opcional de la sala de reuniones. Por ejemplo, “301”. Si se configura, este campo debe ser una string 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 parámetro de 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 string "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 una 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 del curso, se produce 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)

Hora de la actualización más reciente de este curso. Si especificas este campo en una máscara de actualización del curso, se produce 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

Código de inscripción que se usará cuando te unas a este curso. Si especificas este campo en una máscara de actualización del curso, se produce un error.

Solo lectura.
courseState

enum (CourseState)

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 contenga todos los profesores del curso. Este grupo no acepta correos electrónicos y solo se puede usar para obtener permisos.

Solo lectura.
courseGroupEmail

string

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

Solo lectura.
teacherFolder

object (DriveFolder)

Es la 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

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

Solo lectura.
calendarId

string

El ID de calendario de un calendario que pueden ver todos los miembros del curso, en el que Classroom agrega eventos y anuncios del curso

El calendario de un curso se crea de forma asíncrona cuando este se configura 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 del curso de un alumno y a quiénes se mostrará.

Solo lectura

Estado del curso

Estados posibles en los que puede estar un curso.

Enumeradores
COURSE_STATE_UNSPECIFIED Sin estado del curso. Ningún mensaje del Curso que se muestra usará este valor.
ACTIVE El curso está activo.
ARCHIVED Se archivó el curso. Solo puedes modificarlo para cambiarlo a otro estado.
PROVISIONED Se creó el curso, pero aún no se activó. El profesor principal y los administradores del dominio pueden acceder a él y pueden modificarlo o cambiar a los estados ACTIVE o DECLINED. Un curso solo se puede cambiar a PROVISIONED si tiene 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 tiene el estado PROVISIONED.
SUSPENDED Se suspendió el curso. No puedes modificar el curso y solo el usuario identificado por ownerId puede verlo. Un curso se puede colocar en este estado si potencialmente infringe las Condiciones del Servicio.

Conjunto de materiales para cursos

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 u otra información previa 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)

Materiales adjuntos a este conjunto

Material del curso

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)

Video adjunto de YouTube.
form

object (Form)

Archivo adjunto de Formularios de Google.

Configuración del libro de calificaciones

La configuración del libro de calificaciones de un curso. Para obtener más información, consulte 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 disponibles para los trabajos de curso del curso.

Tipo de cálculo

Métodos posibles para el cálculo general de las calificaciones

Enumeradores
CALCULATION_TYPE_UNSPECIFIED No se especificó ningún método. 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.

Configuración de pantalla

Configuración posible para mostrar la calificación general.

Enumeradores
DISPLAY_SETTING_UNSPECIFIED No se especificó ningún parámetro de configuración. Nunca se muestra.
SHOW_OVERALL_GRADE Muestra a los profesores y los alumnos la calificación general en el libro de calificaciones y en el perfil del alumno.
HIDE_OVERALL_GRADE No muestra la calificación general en el libro de calificaciones ni en el perfil del alumno.
SHOW_TEACHERS_ONLY Muestra la calificación general a los profesores en el libro de calificaciones y en el perfil del alumno. Se oculta para los alumnos en su perfil de alumno.

Métodos

checkAddOnCreationEligibility

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

create

 Crea un curso.

delete

 Borra un curso.

get

 Muestra un curso.

list

 Muestra 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 de un curso.

update

 Actualiza un curso.