Google Classroom API

Gestisce corsi, elenchi degli studenti e inviti in Google Classroom.

Servizio: classroom.googleapis.com

Per chiamare questo servizio, ti consigliamo di utilizzare le librerie client fornite da Google. Se la tua applicazione deve utilizzare le tue librerie per chiamare questo servizio, utilizza le seguenti informazioni quando effettui le richieste API.

Documento di rilevamento

Un documento di rilevamento è una specifica leggibile da computer per descrivere e utilizzare le API REST. Viene utilizzato per creare librerie client, plug-in IDE e altri strumenti che interagiscono con le API di Google. Un servizio può fornire più documenti di rilevamento. Questo servizio fornisce il seguente documento di rilevamento:

Endpoint di servizio

Un endpoint di servizio è un URL di base che specifica l'indirizzo di rete di un servizio API. Un servizio può avere più endpoint di servizio. Questo servizio ha il seguente endpoint di servizio e tutti gli URI riportati di seguito sono relativi a questo endpoint di servizio:

  • https://classroom.googleapis.com

Risorsa REST: v1.courses

Metodi
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Restituisce se un utente è idoneo a creare allegati di componenti aggiuntivi in un determinato corso.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Restituisce se un utente è idoneo ad aggiornare GradingPeriodSettings in un determinato corso.
create POST /v1/courses
Crea un corso.
delete DELETE /v1/courses/{id}
Elimina un corso.
get GET /v1/courses/{id}
Restituisce un corso.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Restituisce le impostazioni del periodo di valutazione in un corso.
list GET /v1/courses
Restituisce un elenco di corsi che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta.
patch PATCH /v1/courses/{id}
Aggiorna uno o più campi di un corso.
update PUT /v1/courses/{id}
Aggiorna un corso.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Aggiorna le impostazioni del periodo di valutazione di un corso.

Risorsa REST: v1.courses.aliases

Metodi
create POST /v1/courses/{courseId}/aliases
Crea un alias per un corso.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Consente di eliminare un alias di un corso.
list GET /v1/courses/{courseId}/aliases
Restituisce un elenco di alias per un corso.

Risorsa REST: v1.courses.announcements

Metodi
create POST /v1/courses/{courseId}/announcements
Crea un annuncio.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Elimina un annuncio.
get GET /v1/courses/{courseId}/announcements/{id}
Restituisce un annuncio.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Recupera i metadati dei componenti aggiuntivi di Classroom nel contesto di un post specifico.
list GET /v1/courses/{courseId}/announcements
Restituisce un elenco di annunci che il richiedente è autorizzato a visualizzare.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Modifica la modalità e le opzioni di assegnazione di un annuncio.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Aggiorna uno o più campi di un annuncio.

Risorsa REST: v1.courses.announcements.addOnAttachments

Metodi
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Crea un allegato del componente aggiuntivo sotto un post.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Elimina un allegato del componente aggiuntivo.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Restituisce un allegato di componenti aggiuntivi.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Restituisce tutti gli allegati creati da un componente aggiuntivo sotto il post.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Aggiorna un allegato del componente aggiuntivo.

Risorsa REST: v1.courses.courseWork

Metodi
create POST /v1/courses/{courseId}/courseWork
Crea il lavoro del corso.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Elimina un compito del corso.
get GET /v1/courses/{courseId}/courseWork/{id}
Restituisce il lavoro del corso.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Recupera i metadati dei componenti aggiuntivi di Classroom nel contesto di un post specifico.
list GET /v1/courses/{courseId}/courseWork
Restituisce un elenco dei lavori del corso che il richiedente è autorizzato a visualizzare.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifica la modalità e le opzioni di assegnazione di un corso.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aggiorna uno o più campi di un compito del corso.

Risorsa REST: v1.courses.courseWork.addOnAttachments

Metodi
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Crea un allegato del componente aggiuntivo sotto un post.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Elimina un allegato del componente aggiuntivo.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Restituisce un allegato di componenti aggiuntivi.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Restituisce tutti gli allegati creati da un componente aggiuntivo sotto il post.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Aggiorna un allegato del componente aggiuntivo.

Risorsa REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

Metodi
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Restituisce i contenuti inviati da uno studente per un allegato aggiuntivo.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aggiorna i dati associati all'invio di un allegato del componente aggiuntivo.

Risorsa REST: v1.courses.courseWork.rubrics

Metodi
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Consente di creare una griglia.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Elimina una rubrica.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Restituisce una griglia.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Restituisce un elenco di rubriche che il richiedente può visualizzare.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Aggiorna una rubrica.

Risorsa REST: v1.courses.courseWork.studentSubmissions

Metodi
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Restituisce i contenuti inviati da uno studente.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Restituisce un elenco dei contenuti inviati dagli studenti che l'utente che effettua la richiesta può visualizzare, tenendo conto degli ambiti OAuth della richiesta.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Modifica gli allegati dei contenuti inviati dagli studenti.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Aggiorna uno o più campi di un compito inviato dallo studente.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Recupera i contenuti inviati da uno studente per conto dello studente che li possiede.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Restituisce i contenuti inviati da uno studente.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Consegni un compito dello studente.

Risorsa REST: v1.courses.courseWorkMaterials

Metodi
create POST /v1/courses/{courseId}/courseWorkMaterials
Crea un materiale del corso.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Elimina il materiale del lavoro del corso.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Restituisce un materiale del corso.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Recupera i metadati dei componenti aggiuntivi di Classroom nel contesto di un post specifico.
list GET /v1/courses/{courseId}/courseWorkMaterials
Restituisce un elenco del materiale del corso che il richiedente è autorizzato a visualizzare.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Aggiorna uno o più campi del materiale del lavoro del corso.

Risorsa REST: v1.courses.courseWorkMaterials.addOnAttachments

Metodi
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Crea un allegato del componente aggiuntivo sotto un post.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Elimina un allegato del componente aggiuntivo.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Restituisce un allegato di componenti aggiuntivi.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Restituisce tutti gli allegati creati da un componente aggiuntivo sotto il post.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Aggiorna un allegato del componente aggiuntivo.

Risorsa REST: v1.courses.posts

Metodi
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Recupera i metadati dei componenti aggiuntivi di Classroom nel contesto di un post specifico.

Risorsa REST: v1.courses.posts.addOnAttachments

Metodi
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Crea un allegato del componente aggiuntivo sotto un post.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Elimina un allegato del componente aggiuntivo.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Restituisce un allegato di componenti aggiuntivi.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Restituisce tutti gli allegati creati da un componente aggiuntivo sotto il post.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Aggiorna un allegato del componente aggiuntivo.

Risorsa REST: v1.courses.posts.addOnAttachments.studentSubmissions

Metodi
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Restituisce i contenuti inviati da uno studente per un allegato aggiuntivo.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aggiorna i dati associati all'invio di un allegato del componente aggiuntivo.

Risorsa REST: v1.courses.students

Metodi
create POST /v1/courses/{courseId}/students
Aggiunge un utente come studente di un corso.
delete DELETE /v1/courses/{courseId}/students/{userId}
Consente di eliminare uno studente da un corso.
get GET /v1/courses/{courseId}/students/{userId}
Restituisce uno studente di un corso.
list GET /v1/courses/{courseId}/students
Restituisce un elenco di studenti di questo corso che il richiedente è autorizzato a visualizzare.

Risorsa REST: v1.courses.teachers

Metodi
create POST /v1/courses/{courseId}/teachers
Crea un insegnante di un corso.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Rimuove l'insegnante specificato dal corso specificato.
get GET /v1/courses/{courseId}/teachers/{userId}
Restituisce un insegnante di un corso.
list GET /v1/courses/{courseId}/teachers
Restituisce un elenco di insegnanti del corso che il richiedente è autorizzato a visualizzare.

Risorsa REST: v1.courses.topics

Metodi
create POST /v1/courses/{courseId}/topics
Crea un argomento.
delete DELETE /v1/courses/{courseId}/topics/{id}
Elimina un argomento.
get GET /v1/courses/{courseId}/topics/{id}
Restituisce un argomento.
list GET /v1/courses/{courseId}/topics
Restituisce l'elenco degli argomenti che l'utente che ha effettuato la richiesta può visualizzare.
patch PATCH /v1/courses/{courseId}/topics/{id}
Aggiorna uno o più campi di un argomento.

Risorsa REST: v1.invitations

Metodi
accept POST /v1/invitations/{id}:accept
Accetta un invito, rimuovendolo e aggiungendo l'utente invitato agli insegnanti o agli studenti (a seconda dei casi) del corso specificato.
create POST /v1/invitations
Crea un invito.
delete DELETE /v1/invitations/{id}
Elimina un invito.
get GET /v1/invitations/{id}
Restituisce un invito.
list GET /v1/invitations
Restituisce un elenco di inviti che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta dell'elenco.

Risorsa REST: v1.registrations

Metodi
create POST /v1/registrations
Crea un Registration, in modo che Classroom inizi a inviare notifiche dal feed fornito alla destinazione indicata in cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Consente di eliminare un Registration, in modo che Classroom interrompa l'invio di notifiche per quel Registration.

Risorsa REST: v1.userProfiles

Metodi
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Restituisce se un utente può utilizzare la funzionalità di Classroom specificata.
get GET /v1/userProfiles/{userId}
Restituisce un profilo utente.

Risorsa REST: v1.userProfiles.guardianInvitations

Metodi
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Crea un invito per il tutore e invia un'email al tutore chiedendo di confermare di essere il tutore dello studente.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Restituisce un invito a un tutore specifico.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Restituisce un elenco di inviti per i tutori che l'utente che effettua la richiesta può visualizzare, filtrato in base ai parametri forniti.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modifica un invito al tutore.

Risorsa REST: v1.userProfiles.guardians

Metodi
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Elimina un tutore.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Restituisce un tutore specifico.
list GET /v1/userProfiles/{studentId}/guardians
Restituisce un elenco di tutori che l'utente che effettua la richiesta può visualizzare, limitato a quelli corrispondenti alla richiesta.