La API de Classroom proporciona una interfaz RESTful que te permite administrar cursos y listas en Google Classroom. Además, el botón para compartir de Classroom permite que los desarrolladores y los propietarios del contenido habiliten el uso compartido de su contenido en Classroom.
¿Quién puede usar la API?
Los administradores de dominios de Google Workspace 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 en Classroom. Estas apps deben usar OAuth 2.0 a fin de solicitar permiso para ver las clases y listas de los profesores. Los administradores pueden restringir si los profesores y los alumnos de sus dominios pueden autorizar que las apps accedan a sus datos de Google Classroom.
Los propietarios de sitios web y los desarrolladores de contenido pueden usar el botón para compartir de Classroom para permitir que los alumnos y profesores compartan contenido en Classroom.
Todas las integraciones de la API y del botón para compartir de Classroom deben seguir los lineamientos de desarrollo de la marca de Classroom.
Descripción general 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:
- Cursos
- Alias
- Invitaciones
- Alumnos
- Profesores
- Perfiles de usuario
- Trabajo del curso
- Temas
- Entregas de los alumnos
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 4th period alfath”, y sus profesores, lista de alumnos y metadatos asignados. Cada curso se identifica mediante un ID único que asigna el servidor. El recurso del curso encapsula específicamente todos los metadatos sobre el curso, como el nombre, la descripción, la ubicación y la hora. Las listas de cursos se administran mediante los recursos Invitación, Profesores y Alumnos, y sus métodos.
Los alias son identificadores alternativos para una clase que puede asociarse 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, deben crearse en el espacio de nombres del dominio. Solo los administradores de dominio pueden crear alias en el espacio de nombres del 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 los cursos puede crear alias para asignar su identificador a los 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 del proyecto de desarrollador de esa aplicación.
Para obtener más información sobre cómo administrar metadatos y alias de cursos, consulta Administra cursos.
Lista de cursos y usuarios
Alumnos y 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 alumno y profesor no son globales: un usuario se puede asignar como profesor en un curso y un alumno en otro. La designación “alumno” o “profesor” representa un conjunto de permisos para un usuario específico 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 a los profesores de ese curso.
- Profesores
- Un recurso para profesores representa a un usuario que imparte un curso específico. Los profesores pueden ver y cambiar los detalles del curso, ver a los profesores y alumnos, y administrar a los profesores y los alumnos adicionales.
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 a los usuarios elegir si se unen 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 al perfil de dominio de un usuario según el ID único o la dirección de correo electrónico del usuario que muestra la API de Directory.
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 listas, consulta Cómo administrar profesores y alumnos.
Trabajo del curso y entregas de los alumnos
Un elemento CourseWork representa una tarea individual asignada a un grupo de alumnos en un curso. Contiene detalles como la descripción, la fecha límite y los materiales, así como 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 APIs adecuadas (es decir, Drive y YouTube).
Los elementos de CourseWork describen uno de los siguientes tipos de tareas:
- Una tarea que los alumnos completan mediante el envío de hojas de cálculo u otros archivos adjuntos.
- Una pregunta de respuesta breve o de opción múltiple.
El trabajo de los alumnos en un elemento CourseWork se representa mediante 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 CourseWork 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 los identificadores que se pueden usar con las APIs adecuadas, como Drive o YouTube.
- Es la respuesta a una pregunta de respuesta corta o 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.
Guías de inicio rápido
Para configurar tu entorno y comenzar a usar la API de inmediato, prueba una de estas guías de inicio rápido:
Experimenta con el Explorador de API de Classroom
Para experimentar con métodos de llamada en datos en tiempo real, intenta usar el Explorador de API de Classroom. No es necesario que escribas ningún código para comenzar, pero ten en cuenta que las acciones que realices con el explorador de API pueden modificar los datos existentes.
Una forma de comenzar a llamar a los métodos es realizar una llamada al método courses.list(). Este método no requiere ningún parámetro de solicitud, y puedes recuperar un id de la lista de cursos que se muestra para usarlo como parámetro de solicitud en otras llamadas a la API. Si no tienes ningún curso, puedes crear uno con el método courses.create().
También puedes explorar la referencia de la API.