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

Cuando sea creating a course, de forma opcional, puedes establecer este identificador en un 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 del curso genera un error.

name

string

Nombre del curso. Por ejemplo, "Biología de 10.o 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 más de 2,800 caracteres.

descriptionHeading

string

Encabezado opcional para la descripción. Por ejemplo, "Bienvenidos a la biología de 10.o grado". Si se establece, este campo debe ser una string UTF-8 válida y no más de 3,600 caracteres.

description

string

Descripción opcional. Por ejemplo, "Aprenderemos sobre la estructura de criaturas vivientes a partir de una combinación de libros de texto, conferencias de invitados y trabajos de laboratorio. Será un placer”. Si se establece, este campo debe ser una string UTF-8 válida que no supere los 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 que no supere los 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

Debe configurarse 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. Especificar este campo en una máscara de actualización del curso genera un error.

Solo lectura

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. 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 del curso genera un error.

Solo lectura

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

enrollmentCode

string

Es el código de inscripción que se usará cuando se una a este curso. Especificar este campo en una máscara de actualización del 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 contenga 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 contenga 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 para este curso.

Solo lectura

calendarId

string

El ID de calendario de un calendario que pueden ver todos los miembros del curso, al que Classroom agrega eventos y trabajos del 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 alumno del curso y a quién se mostrará.

Solo lectura

Estado del curso

Estados posibles en los que puede encontrarse un curso.

Enumeradores
COURSE_STATE_UNSPECIFIED Sin estado del curso. Ningún mensaje mostrado del curso usará este valor.
ACTIVE El curso está activo.
ARCHIVED Se archivó el curso. Solo puedes modificarla para que cambie a un estado diferente.
PROVISIONED Se creó el curso, pero todavía no se activó. El profesor principal y los administradores del dominio pueden acceder a ella a fin de modificarla o cambiarla 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. Solo puedes modificar el curso 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 puede quedar en este estado si posiblemente incumple las Condiciones del Servicio.

Conjunto de materiales del curso

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

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

string

Título de este conjunto

materials[]

object (CourseMaterial)

Los materiales adjuntos a este conjunto.

Material del curso

Material que se adjunta 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 para 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)

Las categorías de calificación que están disponibles para los trabajos 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 de los puntos totales, sin importar la categoría.
WEIGHTED_CATEGORIES La calificación general es el promedio ponderado por categoría.

Configuración de visualización

Configuraciones posibles para mostrar la calificación general.

Enumeradores
DISPLAY_SETTING_UNSPECIFIED No se especificó ninguna configuración. Nunca se muestra.
SHOW_OVERALL_GRADE Muestra la calificación general en el libro de calificaciones y en el perfil de los alumnos, tanto a los profesores como a los alumnos.
HIDE_OVERALL_GRADE No muestra las calificaciones generales en el libro de calificaciones ni en el perfil de los alumnos.
SHOW_TEACHERS_ONLY Muestra la calificación general a los profesores en el libro de calificaciones y el perfil del alumno. 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 cursos que el usuario que realiza la solicitud puede ver, restringido a los que coinciden con la solicitud.

patch

Actualiza uno o más campos de un curso.

update

Actualiza un curso.