La API de Classroom proporciona una interfaz RESTful para que administres los cursos y las listas en Google Classroom. Además, el botón para compartir de Classroom permite que los desarrolladores y propietarios del contenido habiliten el uso compartido de su contenido en Classroom.
¿Quiénes pueden usar la API?
Los administradores de dominio de Google Workspace for Education pueden usar la API para aprovisionar de forma programática cursos en nombre de los profesores, sincronizar los sistemas de información de 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 las listas de los profesores. Los administradores pueden restringir si los profesores y los estudiantes de sus dominios pueden autorizar que las apps accedan a sus datos de Google Classroom.
Los propietarios de los sitios web y los desarrolladores de contenido pueden usar el botón para compartir de Classroom para permitir que los estudiantes y profesores compartan contenido en Classroom.
Todas las integraciones de los botones para compartir de la API y 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 estudiantes 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 estudiantes
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 math”, y los profesores asignados, la lista de estudiantes y los metadatos. Cada curso se identifica con un ID único asignado por el servidor. El recurso del curso encapsula de forma específica todos los metadatos sobre el curso, como el nombre, la descripción, la ubicación y la hora. Las listas de cursos se administran a través de los recursos Invitación, profesores y Estudiantes, y sus métodos.
Los alias son identificadores alternativos para una clase que se puede asociar 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 necesiten acceso, pero que no son específicos de ningún programa. Por ejemplo, en el espacio de nombres del dominio, se deben crear fichas alternativas para un curso, como MATH 127 y COMSCI 127. Solo los administradores del dominio pueden crear los alias en el espacio de nombres del dominio, pero son visibles para todos los usuarios en un dominio.
- Proyecto del desarrollador: El espacio de nombres del proyecto del 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 los cursos de Classroom. Los alias creados en este espacio de nombres están vinculados a una Consola de APIs 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 Administrar cursos.
Listados de cursos y usuarios
Estudiantes 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 estudiante y profesor no son globales: se puede asignar un usuario como profesor en un curso y un estudiante en otro. La designación “estudiante” o “profesor” representa un conjunto de permisos para un usuario específico en un curso determinado.
- Alumnos
Un recurso para estudiantes representa a un usuario que está inscrito como estudiante en
un curso específico. Los estudiantes pueden ver los detalles del curso y a los profesores de ese curso.
- Profesores
Un recurso para profesores representa a un usuario que dicta un curso específico.
Los profesores pueden ver y cambiar los detalles del curso, ver profesores y estudiantes, y administrar profesores y estudiantes adicionales.
Las invitaciones y sus métodos asociados proporcionan una forma conveniente de agregar estudiantes y profesores a los cursos. La creación de invitaciones permite a los usuarios elegir si se unen a un curso o no, en lugar de agregarlos directamente a través de los recursos para profesores y estudiantes.
Los UserProfiles representan una asignación al perfil de dominio de un usuario identificado por 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 la administración de listas, consulta Cómo administrar profesores y alumnos.
Trabajo del curso y entregas de los estudiantes
Un elemento de CourseWork representa una sola tarea asignada a un grupo de estudiantes 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, una URL y un identificador que se puede usar con las APIs correspondientes (es decir, Drive y YouTube).
Los elementos del curso describen uno de los siguientes tipos de tareas:
- Una tarea que los estudiantes completan con hojas de cálculo u otros archivos adjuntos.
- Una pregunta de respuesta corta o de opción múltiple.
El trabajo de los alumnos para un elemento de 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 correspondiente del curso:
- Las hojas de cálculo y los archivos adjuntos que se envían 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 estudiantes, consulta Cómo administrar el trabajo en clase.
Complementos de Classroom
Un complemento es una IU y un backend entregados por socios que, por lo general, se muestran en un iframe. Los complementos aparecen como archivos adjuntos en una publicación, que puede ser Announcements, CourseWork o CourseWorkMaterials.
Los archivos adjuntos de complementos pueden ser actividad o contenido.
- Los archivos adjuntos de actividades requieren que el estudiante complete y entregue una entrega individual. Entre los ejemplos, se incluyen cuestionarios, dibujos o juegos. El envío de una actividad se puede calificar de forma opcional.
- Los archivos adjuntos de contenido no requieren la entrega de un estudiante. No es necesario que el estudiante entregue el archivo adjunto, ya que este no se califica. Por ejemplo, fotos, artículos y videos.
Consulta las guías de desarrollo de complementos para obtener más información.
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 APIs de Google
Para experimentar los métodos de llamada en datos en tiempo real, prueba usar el Explorador de APIs de Google. No necesitas escribir ningún código para comenzar, pero ten en cuenta que las acciones que realizas con el Explorador de APIs pueden modificar 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 que se muestra de cursos para usarlo como parámetro de solicitud para 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.