Google Classroom API

Administra las clases, las listas y las invitaciones en Google Classroom.

Servicio: classroom.googleapis.com

Para llamar a este servicio, te recomendamos que uses las bibliotecas cliente que proporciona Google. Si tu aplicación necesita usar tus propias bibliotecas para llamar a este servicio, usa la información siguiente 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 documento de descubrimiento siguiente:

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
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Muestra si un usuario es apto para crear archivos adjuntos de complementos en un curso determinado.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Muestra si un usuario es apto para actualizar GradingPeriodSettings en un curso determinado.
create POST /v1/courses
Crea un curso.
delete DELETE /v1/courses/{id}
Borra un curso.
get GET /v1/courses/{id}
Muestra un curso.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Devuelve la configuración del período de calificación de un curso.
list GET /v1/courses
Muestra una lista de cursos que el usuario solicitante puede ver, restringida a los que coinciden con la solicitud.
patch PATCH /v1/courses/{id}
Actualiza uno o más campos en un curso.
update PUT /v1/courses/{id}
Actualiza un curso.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Actualiza la configuración del período de calificación de 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 el 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.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Obtiene los metadatos de los complementos de Classroom en el contexto de una publicación específica.
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 asignación 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.announcements.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Crea un archivo adjunto del complemento debajo de una publicación.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Borra un archivo adjunto del complemento.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Muestra un archivo adjunto de complemento.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Muestra todos los archivos adjuntos creados por un complemento en la publicación.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto de complemento.

Recurso de REST: v1.courses.courseWork

Métodos
create POST /v1/courses/{courseId}/courseWork
Crea tareas del curso.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Borra un trabajo del curso.
get GET /v1/courses/{courseId}/courseWork/{id}
Muestra el trabajo del curso.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Obtiene metadatos de los complementos de Classroom en el contexto de una publicación específica.
list GET /v1/courses/{courseId}/courseWork
Muestra una lista del trabajo del curso que el solicitante puede ver.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifica el modo de usuario asignado y las opciones del trabajo de curso.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Actualiza uno o más campos de un trabajo del curso.

Recurso de REST: v1.courses.courseWork.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Crea un archivo adjunto de complemento debajo de una publicación.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Borra un archivo adjunto del complemento.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Muestra un archivo adjunto de complemento.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Muestra todos los archivos adjuntos que creó un complemento en la publicación.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto de complemento.

Recurso de REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Devuelve una entrega de un estudiante para un archivo adjunto de complemento.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Actualiza los datos asociados con el envío de un archivo adjunto de complemento.

Recurso de REST: v1.courses.courseWork.rubrics

Métodos
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Crea una rúbrica.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Borra una rúbrica.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Muestra una rúbrica.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Muestra una lista de rúbricas que el solicitante puede ver.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Actualiza una rúbrica.

Recurso de REST: v1.courses.courseWork.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Muestra la entrega de un estudiante.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Muestra una lista de las entregas de los estudiantes 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 las entregas de los estudiantes.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Actualiza uno o más campos de una entrega de un estudiante.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Recupera una entrega de un estudiante en nombre del estudiante que la posee.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Muestra la entrega de un estudiante.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Entrega la tarea de un estudiante.

Recurso de REST: v1.courses.courseWorkMaterials

Métodos
create POST /v1/courses/{courseId}/courseWorkMaterials
Crea un material de trabajo del curso.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Borra el material de trabajo de un curso.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Muestra un material de trabajo del curso.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Obtiene los metadatos de los complementos de Classroom en el contexto de una publicación específica.
list GET /v1/courses/{courseId}/courseWorkMaterials
Devuelve una lista del material de trabajo del curso que el solicitante puede ver.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Actualiza uno o más campos de un material de trabajo del curso.

Recurso de REST: v1.courses.courseWorkMaterials.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Crea un archivo adjunto de complemento debajo de una publicación.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Borra un archivo adjunto del complemento.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Muestra un archivo adjunto del complemento.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Muestra todos los archivos adjuntos creados por un complemento debajo de la publicación.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto de complemento.

Recurso de REST: v1.courses.posts

Métodos
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Obtiene los metadatos de los complementos de Classroom en el contexto de una publicación específica.

Recurso de REST: v1.courses.posts.addOnAttachments

Métodos
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Crea un archivo adjunto de complemento debajo de una publicación.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Borra un archivo adjunto del complemento.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Muestra un archivo adjunto de complemento.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Muestra todos los archivos adjuntos que creó un complemento en la publicación.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto de complemento.

Recurso de REST: v1.courses.posts.addOnAttachments.studentSubmissions

Métodos
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Muestra la entrega de un estudiante para un archivo adjunto de complemento.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Actualiza los datos asociados con el envío de un archivo adjunto de complemento.

Recurso de REST: v1.courses.students

Métodos
create POST /v1/courses/{courseId}/students
Agrega un usuario como estudiante de un curso.
delete DELETE /v1/courses/{courseId}/students/{userId}
Borra a un estudiante de un curso.
get GET /v1/courses/{courseId}/students/{userId}
Muestra un estudiante de un curso.
list GET /v1/courses/{courseId}/students
Muestra una lista de estudiantes 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 los 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 al usuario invitado a los profesores o estudiantes (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 solicitante 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 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
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Muestra si un usuario puede usar la función especificada de Classroom.
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 le envía un correo electrónico para que confirme que es el tutor del estudiante.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Devuelve una invitación específica para el tutor.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Muestra una lista de invitaciones de guardián que el usuario solicitante puede ver, filtradas según los parámetros proporcionados.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modifica la invitación para un tutor.

Recurso de REST: v1.userProfiles.guardians

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