Google Classroom API

Administrar clases, listas e invitaciones en Google Classroom

Servicio: classroom.googleapis.com

Para llamar a este servicio, te recomendamos usar las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la siguiente información cuando realices las solicitudes a la API.

Documento de descubrimiento

Un Documento de descubrimiento es una especificación procesable para describir y consumir las API de REST. Se usa para compilar bibliotecas cliente, complementos IDE y otras herramientas que interactúan con las API de Google. Un servicio puede proporcionar varios documentos de descubrimiento. Este servicio proporciona el siguiente documento de descubrimiento:

Extremo de servicio

Un extremo de servicio es una URL base que especifica la dirección de la red de un servicio de API. Un servicio puede tener varios extremos de servicio. Este servicio tiene el siguiente extremo, y todos los URI que se muestran a continuación son relativos a él:

  • https://classroom.googleapis.com

Recurso de REST: v1.courses

Métodos
create POST /v1/courses
Crea un curso.
delete DELETE /v1/courses/{id}
Borra un curso.
get GET /v1/courses/{id}
Muestra un curso.
list GET /v1/courses
Muestra una lista de cursos que el usuario solicitante puede ver, restringido a los que coinciden con la solicitud.
patch PATCH /v1/courses/{id}
Actualiza uno o más campos de un curso.
update PUT /v1/courses/{id}
Actualiza un curso.

Recurso de REST: v1.courses.aliases

Métodos
create POST /v1/courses/{courseId}/aliases
Crea un alias para un curso.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Borra un alias de un curso.
list GET /v1/courses/{courseId}/aliases
Muestra una lista de alias de un curso.

Recurso de REST: v1.courses.announcements

Métodos
create POST /v1/courses/{courseId}/announcements
Crea un anuncio.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Borra un anuncio.
get GET /v1/courses/{courseId}/announcements/{id}
Muestra un anuncio.
list GET /v1/courses/{courseId}/announcements
Muestra una lista de anuncios que el solicitante puede ver.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Modifica el modo de usuario asignado y las opciones de un anuncio.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Actualiza uno o más campos de un anuncio.

Recurso de REST: v1.courses.courseWork

Métodos
create POST /v1/courses/{courseId}/courseWork
Crea un trabajo de curso.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Borra un trabajo del curso.
get GET /v1/courses/{courseId}/courseWork/{id}
Devuelve el trabajo del curso.
list GET /v1/courses/{courseId}/courseWork
Muestra una lista de trabajos de curso que el solicitante puede ver.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifica el modo de usuario asignado y las opciones de un trabajo del curso.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Actualiza uno o más campos del trabajo de un curso.

Recurso de REST: v1.courses.courseWork.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Muestra las entregas de un alumno.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Muestra una lista de las entregas de los alumnos que el solicitante puede ver, teniendo en cuenta los permisos de OAuth de la solicitud.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Modifica los archivos adjuntos de la entrega de los alumnos.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Actualiza uno o más campos de la entrega de un alumno.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Reclama las entregas de alumnos en nombre del alumno propietario.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Muestra las entregas de un alumno.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Entrega una entrega de los alumnos.

Recurso de REST: v1.courses.courseWorkMaterials

Métodos
create POST /v1/courses/{courseId}/courseWorkMaterials
Crea un material de trabajo para el curso.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Borra un material de trabajo del curso.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Muestra un material de trabajo del curso.
list GET /v1/courses/{courseId}/courseWorkMaterials
Muestra una lista de materiales de trabajo del curso que el solicitante puede ver.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Actualiza uno o más campos del material de trabajo de un curso.

Recurso de REST: v1.courses.students

Métodos
create POST /v1/courses/{courseId}/students
Agrega a un usuario como alumno de un curso.
delete DELETE /v1/courses/{courseId}/students/{userId}
Borra un alumno de un curso.
get GET /v1/courses/{courseId}/students/{userId}
Muestra un alumno de un curso.
list GET /v1/courses/{courseId}/students
Muestra una lista de alumnos de este curso que el solicitante puede ver.

Recurso de REST: v1.courses.teachers

Métodos
create POST /v1/courses/{courseId}/teachers
Crea un profesor de un curso.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Quita al profesor especificado del curso especificado.
get GET /v1/courses/{courseId}/teachers/{userId}
Muestra al profesor de un curso.
list GET /v1/courses/{courseId}/teachers
Muestra una lista de profesores de este curso que el solicitante puede ver.

Recurso de REST: v1.courses.topics

Métodos
create POST /v1/courses/{courseId}/topics
Crea un tema.
delete DELETE /v1/courses/{courseId}/topics/{id}
Borra un tema.
get GET /v1/courses/{courseId}/topics/{id}
Muestra un tema.
list GET /v1/courses/{courseId}/topics
Muestra la lista de temas que el solicitante puede ver.
patch PATCH /v1/courses/{courseId}/topics/{id}
Actualiza uno o más campos de un tema.

Recurso de REST: v1.invitations

Métodos
accept POST /v1/invitations/{id}:accept
Acepta una invitación, la quita y agrega el usuario invitado a los profesores o los alumnos (según corresponda) del curso especificado.
create POST /v1/invitations
Crea una invitación.
delete DELETE /v1/invitations/{id}
Borra una invitación.
get GET /v1/invitations/{id}
Muestra una invitación.
list GET /v1/invitations
Muestra una lista de invitaciones que el usuario que realiza la solicitud puede ver, restringida a aquellas que coinciden con la solicitud de lista.

Recurso de REST: v1.registrations

Métodos
create POST /v1/registrations
Crea un Registration, lo que hace que Classroom comience a enviar notificaciones desde el elemento feed proporcionado al destino proporcionado en cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Borra un Registration, lo que hace que Classroom deje de enviar notificaciones para ese Registration.

Recurso de REST: v1.userProfiles

Métodos
get GET /v1/userProfiles/{userId}
Muestra un perfil de usuario.

Recurso de REST: v1.userProfiles.guardianInvitations

Métodos
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Crea una invitación para el tutor y envía un correo electrónico al tutor para pedirle que confirme que es su tutor.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Muestra una invitación específica del tutor.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Muestra una lista de invitaciones de tutores que el usuario que solicitó permiso podrá ver y que se filtren según los parámetros proporcionados.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modificar una invitación para tutores

Recurso de REST: v1.userProfiles.guardians

Métodos
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Borra un tutor.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Muestra un tutor específico.
list GET /v1/userProfiles/{studentId}/guardians
Muestra una lista de los tutores que el usuario que realiza la solicitud puede ver, restringido a aquellos que coincidan con la solicitud.