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)
  }
}
Campos
id

string

Identificador de este curso que asigna Classroom.

Cuando creating a course, tienes la opción de establecer este identificador en 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.

Si especificas este campo en una máscara de actualización de cursos, se producirá 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 una string UTF-8 válida.

section

string

Sección del curso. Por ejemplo, "Período 2". Si se establece, 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 la Biología para el 10o grado". Si se establece, 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 criaturas vivas a partir de una combinación de libros de texto, conferencias de invitados y trabajo de laboratorio. Será un placer”. Si se establece, 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 establece, 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 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 string "me", que indica el usuario solicitante

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)

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

Es una marca de tiempo en formato RFC3339 UTC “Zulú”, 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)

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

Es una marca de tiempo en formato RFC3339 UTC “Zulú”, 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 que puedes 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 puede usarse con 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 puede usarse con 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

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

Solo lectura

calendarId

string

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

El calendario de un curso se crea de forma asíncrona cuando 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 de un alumno para el curso y a quién se mostrará

Permiso de 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 devuelto usará este valor.
ACTIVE El curso está activo.
ARCHIVED Se archivó el curso. Solo puedes modificarlo para que cambie a un estado diferente.
PROVISIONED Se creó el curso, pero todavía no se activó. Pueden acceder al profesor principal y a 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ó. 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 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. Si un curso puede infringir las Condiciones del Servicio, posiblemente se ubique en este estado.

Conjunto de materiales del curso

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

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

string

Título para este juego.

materials[]

object (CourseMaterial)

Materiales adjuntos a este juego.

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
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 adjunto de video 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, consulta este 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)

Califica las categorías que están disponibles para el curso del curso.

Tipo de cálculo

Posibles métodos del 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 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 la pantalla

Es una 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 la calificación general del libro de calificaciones y del perfil de los alumnos a los profesores y alumnos.
HIDE_OVERALL_GRADE No se muestra la calificación general en el libro de calificaciones o el perfil de alumno.
SHOW_TEACHERS_ONLY Muestra la calificación general a los profesores en el libro de calificaciones y el perfil de los alumnos. Se oculta de los alumnos en su perfil de alumno.

Métodos

create

Crea un curso.

delete

Borra un curso.

get

Muestra un curso.

list

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

patch

Actualiza uno o más campos de un curso.

update

Actualiza un curso.