Google Classroom API

Administra clases, listas e 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
Devuelve si un usuario es apto para crear archivos adjuntos de complementos en un curso determinado.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Devuelve 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}
Devuelve 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
Devuelve una lista de los cursos que el usuario solicitante tiene permiso para 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 un alias de un curso.
list GET /v1/courses/{courseId}/aliases
Devuelve una lista de alias para 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}
Devuelve un anuncio.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Obtiene metadatos para los complementos de Classroom en el contexto de una publicación específica.
list GET /v1/courses/{courseId}/announcements
Devuelve una lista de anuncios que el solicitante tiene permiso para ver.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Modifica el modo y las opciones del asignatario 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 en 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}
Devuelve un archivo adjunto del complemento.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Devuelve 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 del complemento.

Recurso de REST: v1.courses.courseWork

Métodos
create POST /v1/courses/{courseId}/courseWork
Crea trabajo del 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.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Obtiene metadatos para los complementos de Classroom en el contexto de una publicación específica.
list GET /v1/courses/{courseId}/courseWork
Devuelve una lista de trabajos del curso que el solicitante tiene permiso para ver.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifica el modo y las opciones de asignación de un 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 del complemento en 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}
Devuelve un archivo adjunto del complemento.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Devuelve todos los archivos adjuntos creados por un complemento en la publicación.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto del complemento.

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

Métodos
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Devuelve la 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 del 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}
Devuelve una rúbrica.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Devuelve una lista de las rúbricas que el solicitante tiene permiso para 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}
Devuelve el envío de un estudiante.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Devuelve una lista de las entregas de los estudiantes que el solicitante tiene permiso para ver, teniendo en cuenta los alcances de OAuth de la solicitud.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Modifica los archivos adjuntos de la entrega del estudiante.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Actualiza uno o más campos de un envío de estudiante.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Recupera una entrega de un estudiante en nombre del estudiante propietario.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Devuelve el envío 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 un material del curso.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Devuelve un material de trabajo del curso.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Obtiene metadatos para 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 tiene permiso para 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 del complemento en 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}
Devuelve un archivo adjunto del complemento.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Devuelve todos los archivos adjuntos creados por un complemento en la publicación.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto del complemento.

Recurso de REST: v1.courses.posts

Métodos
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Obtiene metadatos para 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 del complemento en 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}
Devuelve un archivo adjunto del complemento.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Devuelve todos los archivos adjuntos creados por un complemento en la publicación.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Actualiza un archivo adjunto del complemento.

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

Métodos
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Devuelve 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 del complemento.

Recurso de REST: v1.courses.studentGroups

Métodos
create POST /v1/courses/{courseId}/studentGroups
Crea un grupo de estudiantes para un curso.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Borra un grupo de estudiantes.
list GET /v1/courses/{courseId}/studentGroups
Devuelve una lista de los grupos de un curso.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Actualiza uno o más campos en un grupo de estudiantes.

Recurso de REST: v1.courses.studentGroups.studentGroupMembers

Métodos
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Crea un miembro del grupo de estudiantes para un grupo de estudiantes.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Borra un miembro de un grupo de estudiantes.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Devuelve una lista de los estudiantes de un grupo.

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}
Devuelve un estudiante de un curso.
list GET /v1/courses/{courseId}/students
Devuelve una lista de los estudiantes de este curso que el solicitante tiene permiso para 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}
Devuelve un profesor de un curso.
list GET /v1/courses/{courseId}/teachers
Devuelve una lista de los profesores de este curso que el solicitante tiene permiso para 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}
Devuelve un tema.
list GET /v1/courses/{courseId}/topics
Muestra la lista de temas que el solicitante tiene permiso para 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}
Devuelve una invitación.
list GET /v1/invitations
Devuelve una lista de las invitaciones que el usuario solicitante tiene permiso para ver, restringidas a las que coinciden con la solicitud de lista.

Recurso de REST: v1.registrations

Métodos
create POST /v1/registrations
Crea un objeto Registration, lo que hace que Classroom comience a enviar notificaciones desde el objeto 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
Devuelve si un usuario puede usar la capacidad de Classroom especificada.
get GET /v1/userProfiles/{userId}
Devuelve 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 en el que se le pide que confirme que es el tutor del estudiante.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Devuelve una invitación específica para ser tutor.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Devuelve una lista de invitaciones de tutor que el usuario solicitante tiene permiso para ver, filtradas por los parámetros proporcionados.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modifica una invitación de tutor.

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}
Devuelve un tutor específico.
list GET /v1/userProfiles/{studentId}/guardians
Devuelve una lista de tutores que el usuario solicitante tiene permiso para ver, restringida a aquellos que coinciden con la solicitud.