Google Classroom API

Gestisce i corsi, gli elenchi degli studenti e gli 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, usa le seguenti informazioni quando effettui le richieste API.

Documento di rilevamento

Un documento di rilevamento è una specifica leggibile dalle macchine 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 di seguito sono relativi a questo endpoint di servizio:

  • https://classroom.googleapis.com

Risorsa REST: v1.courses

Metodi
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Indica se un utente è idoneo a creare allegati di componenti aggiuntivi 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.
list GET /v1/courses
Restituisce un elenco di corsi che l'utente richiedente può visualizzare, limitato a quelli che corrispondono alla richiesta.
patch PATCH /v1/courses/{id}
Aggiorna uno o più campi di un corso.
update PUT /v1/courses/{id}
Aggiorna 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}
Elimina l'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 per i 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 dell'assegnatario 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 di componenti aggiuntivi 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 che si trova sotto il post.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Consente di aggiornare l'allegato di un 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 il lavoro di un corso.
get GET /v1/courses/{courseId}/courseWork/{id}
Restituisce il lavoro del corso.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Recupera i metadati per i componenti aggiuntivi di Classroom nel contesto di un post specifico.
list GET /v1/courses/{courseId}/courseWork
Restituisce un elenco del lavoro del corso che il richiedente è autorizzato a visualizzare.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Modifica la modalità e le opzioni dell'assegnatario di un'attività del corso.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Aggiorna uno o più campi di un lavoro del corso.

Risorsa REST: v1.courses.courseWork.addOnAttachments

Metodi
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Crea un allegato di componenti aggiuntivi 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 che si trova sotto il post.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Consente di aggiornare l'allegato di un componente aggiuntivo.

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

Metodi
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Restituisce il compito inviato dallo studente per un allegato di un componente aggiuntivo.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aggiorna i dati associati all'invio di un allegato di componenti aggiuntivi.

Risorsa REST: v1.courses.courseWork.rubrics

Metodi
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Crea una griglia.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Elimina una griglia.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Restituisce una griglia.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Restituisce un elenco di griglie che il richiedente è autorizzato a visualizzare.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Aggiorna una griglia.

Risorsa REST: v1.courses.courseWork.studentSubmissions

Metodi
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Restituisce un compito inviato da uno studente.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Restituisce un elenco dei contenuti inviati dagli studenti che il richiedente è autorizzato a 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 dei contenuti inviati da uno studente.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Rivendica un compito inviato da uno studente per conto dello studente proprietario.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Restituisce un compito inviato da uno studente.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Consegna un compito dello studente.

Risorsa REST: v1.courses.courseWorkMaterials

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

Risorsa REST: v1.courses.courseWorkMaterials.addOnAttachments

Metodi
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Crea un allegato di componenti aggiuntivi 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 che si trova sotto il post.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Consente di aggiornare l'allegato di un componente aggiuntivo.

Risorsa REST: v1.courses.posts

Metodi
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Recupera i metadati per i 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 di componenti aggiuntivi 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 che si trova sotto il post.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Consente di aggiornare l'allegato di un componente aggiuntivo.

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

Metodi
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Restituisce il compito inviato dallo studente per un allegato di un componente aggiuntivo.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Aggiorna i dati associati all'invio di un allegato di componenti aggiuntivi.

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}
Elimina uno studente di un corso.
get GET /v1/courses/{courseId}/students/{userId}
Restituisce uno studente di un corso.
list GET /v1/courses/{courseId}/students
Restituisce un elenco degli studenti di questo corso che il richiedente può visualizzare.

Risorsa REST: v1.courses.teachers

Metodi
create POST /v1/courses/{courseId}/teachers
Crea l'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 l'insegnante di un corso.
list GET /v1/courses/{courseId}/teachers
Restituisce un elenco degli insegnanti di questo 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 di argomenti che il richiedente è autorizzato a 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 l'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 richiedente può visualizzare, limitato a quelli che corrispondono alla richiesta di elenco.

Risorsa REST: v1.registrations

Metodi
create POST /v1/registrations
Crea un Registration, per cui Classroom inizia a inviare notifiche dal feed fornito alla destinazione indicata in cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Elimina un Registration, di conseguenza Classroom non invia più notifiche per quel Registration.

Risorsa REST: v1.userProfiles

Metodi
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 per chiedergli di confermare che è il tutore dello studente.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Restituisce un invito specifico come tutore.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Restituisce un elenco di inviti di tutori che l'utente richiedente è autorizzato a visualizzare, filtrato in base ai parametri forniti.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Modifica l'invito di un 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 richiedente è autorizzato a visualizzare, limitato a quelli che soddisfano la richiesta.