Recientes

La API de Classroom proporciona una interfaz RESTful que te permite administrar cursos y listas en Google Classroom. Además, el botón Compartir en Classroom permite a los desarrolladores y propietarios de contenido habilitar el uso compartido de su contenido en Classroom.

¿Quién puede usar la API?

Los administradores de dominio de G Suite for Education pueden usar la API para aprovisionar cursos de manera programática en nombre de los profesores, sincronizar los sistemas de información de los alumnos con Classroom y obtener visibilidad básica de las clases que se enseñan en su dominio.

Los desarrolladores de aplicaciones pueden usar la API de Classroom para integrar sus apps con Classroom. Estas apps deben usar OAuth 2.0 a fin de solicitar permiso para ver las clases y las listas de los profesores. Los administradores pueden restringir si los profesores y los alumnos de su dominio pueden autorizar a las apps para que accedan a sus datos de Google Classroom.

Los propietarios de sitios web y los desarrolladores de contenido pueden usar el botón Compartir de Classroom para permitir que los alumnos y los profesores vuelvan a compartir contenido con Classroom.

Todas las integraciones de los botones para compartir la API y Classroom deben seguir los lineamientos de marca de Classroom.

Resumen de la API

La API de Classroom consta de varios tipos de entidades que corresponden a clases, profesores y alumnos en la interfaz de Classroom. Algunas de estas entidades tienen propiedades adicionales específicas de la API, además de lo que existe en Classroom. Los tipos de entidades principales son los siguientes:

Para obtener información detallada sobre los recursos y métodos de la API, consulta la referencia de la API de Classroom.

Alias y metadatos del curso

Los cursos representan una clase, como &M. Smith's 4.o cálculo matemático y los profesores asignados, lista de estudiantes y metadatos. Cada curso se identifica con un ID único asignado por el servidor. El recurso del curso encapsula específicamente todos los metadatos del curso, como el nombre, la descripción, la ubicación y la hora. Las listas de cursos se administran por medio de los recursos Student, Teacher y Invitación, y sus métodos.

Los alias son identificadores alternativos para una clase que pueden estar asociados con un curso y usarse en lugar del ID único. Cada alias existe en un espacio de nombres que restringe quién puede crearlo y verlo. Se admiten dos espacios de nombres:

  • Dominio: El espacio de nombres del dominio es útil para crear alias a los que todos los usuarios necesitan acceso, pero que no son específicos de ningún programa. Por ejemplo, las fichas alternativas de un curso, como MATH 127 y COMSCI 127, se deben crear en el espacio de nombres de dominio. Solo los administradores del dominio pueden crear alias en el espacio de nombres de dominio, pero todos los usuarios de un dominio pueden verlos.
  • Proyecto de desarrollador: El espacio de nombres del proyecto de desarrollador es útil para administrar alias específicos de una aplicación. Por ejemplo, una aplicación que usa identificadores alternativos para cursos puede crear alias para asignar su identificador a cursos de Classroom. Los alias creados en este espacio de nombres están vinculados a una Consola de API de Google específica. Cualquier usuario de una aplicación puede crear y ver alias en el espacio de nombres para el proyecto de desarrollador de esa aplicación.

Para obtener más información sobre la administración de metadatos y alias de cursos, consulta Cómo administrar cursos.

Listas y usuarios del curso

Los alumnos y los profesores son asignaciones específicas entre un perfil de usuario y un curso, que representan la función de ese usuario en el curso. Las designaciones de alumnos y profesores no son globales: se puede asignar a un usuario como profesor para un curso y como alumno en otro. La designación "estudiante" o "profesor" representa un conjunto de permisos para un usuario en particular en un curso determinado.

Alumnos
Un recurso para alumnos representa a un usuario que está inscrito como alumno en un curso específico. Los alumnos pueden ver los detalles del curso y los profesores correspondientes.
Profesores
Un recurso de profesor representa a un usuario que dicta un curso específico. Los profesores pueden ver y cambiar los detalles del curso, además de ver a los profesores y los alumnos, además de administrar a otros profesores y alumnos.

Las invitaciones y sus métodos asociados proporcionan una forma conveniente de agregar alumnos y profesores a los cursos. La creación de invitaciones permite que los usuarios elijan si desean unirse o no a un curso, en lugar de agregarlos directamente a través de los recursos para profesores y alumnos.

Los UserProfiles representan una asignación a un perfil de dominio de un usuario identificado por el ID único o la dirección de correo electrónico del usuario que muestra el SDK de Google Admin. El usuario actual también puede hacer referencia a su propio ID con la abreviatura "me".

Para obtener más información sobre cómo administrar las listas, consulta Cómo administrar a los profesores y los alumnos.

Tareas y entregas de los alumnos

Un elemento CourseWork representa una sola tarea asignada a un grupo de alumnos de un curso. Contiene detalles como la descripción, la fecha límite y los materiales, además de metadatos como la hora de creación. Los materiales incluyen un título, una miniatura y una URL, así como un identificador que se puede usar con las API adecuadas (es decir, Drive y YouTube).

Los elementos de CourseWork describen uno de los siguientes tipos de tareas:

  • Una tarea que los alumnos completan enviando hojas de cálculo o archivos adjuntos.
  • Una pregunta de respuesta corta o de opción múltiple.

El trabajo de un alumno de un elemento CourseWork se representa con una StudentSubmission. Consiste en una respuesta y metadatos adicionales, como un estado y una calificación asignada.

El contenido de una StudentSubmission depende del tipo del elemento de WorkWork correspondiente:

  • Las hojas de cálculo y los archivos adjuntos enviados para una tarea, incluidos el título, la miniatura y la URL, así como identificadores que se pueden usar con las API adecuadas, como Drive o YouTube.
  • Es la respuesta a una pregunta de respuesta corta o a una de opción múltiple.

Para obtener más información sobre cómo administrar el trabajo del curso y las entregas de los alumnos, consulta Cómo administrar el trabajo en clase.

Comienza ahora

Para configurar el entorno y comenzar a usar la API de inmediato, sigue una de las guías de inicio rápido:

También puedes explorar la referencia de la API.