Panoramica

L'API Classroom fornisce un'interfaccia RESTful per gestire i corsi e gli elenchi degli studenti in Google Classroom. Inoltre, il pulsante di condivisione Classroom consente agli sviluppatori e ai proprietari di contenuti di abilitare la condivisione dei propri contenuti con Classroom.

Chi può utilizzare l'API?

Gli amministratori di dominio Google Workspace for Education possono utilizzare l'API per eseguire il provisioning programmatico dei corsi per conto degli insegnanti, sincronizzare i sistemi informativi degli studenti con Classroom e ottenere una visibilità di base sui corsi insegnati nel proprio dominio.

Gli sviluppatori di applicazioni possono usare l'API Classroom per integrare le proprie app in Classroom. Queste app devono utilizzare OAuth 2.0 per richiedere l'autorizzazione di visualizzazione dei corsi e degli elenchi degli studenti agli insegnanti. Gli amministratori possono limitare l'autorizzazione degli insegnanti e degli studenti del loro dominio per l'accesso delle app ai dati di Google Classroom.

I proprietari di siti web e gli sviluppatori di contenuti possono utilizzare il pulsante di condivisione Classroom per consentire a studenti e insegnanti di condividere contenuti in Classroom.

Tutte le integrazioni dei pulsanti di condivisione di API e Classroom devono seguire le linee guida per il branding di Classroom.

Panoramica dell'API

L'API Classroom è composta da diversi tipi di entità che corrispondono a classi, insegnanti e studenti nell'interfaccia di Classroom. Alcune di queste entità hanno proprietà aggiuntive specifiche dell'API oltre a quelle presenti in Classroom. I tipi di entità principali sono:

Per informazioni dettagliate sulle risorse e sui metodi dell'API, consulta la documentazione di riferimento sull'API Classroom.

Metadati e alias del corso

I corsi rappresentano un corso, ad esempio "M. "Quarto periodo di matematica di Smith" e i relativi insegnanti, l'elenco degli studenti e i metadati. Ogni corso è identificato da un ID univoco assegnato dal server. La risorsa Corso incapsula in modo specifico tutti i metadati del corso, come nome, descrizione, località e ora. Gli elenchi degli studenti dei corsi sono gestiti tramite le risorse Studente, Insegnante e Invito e i relativi metodi.

Gli alias sono identificatori alternativi di una classe, che possono essere associati a un corso e utilizzati al posto dell'ID univoco. Ogni alias esiste in uno spazio dei nomi che limita chi può crearlo e visualizzarlo. Sono supportati due spazi dei nomi:

  • Dominio: lo spazio dei nomi del dominio è utile per creare alias a cui tutti gli utenti devono accedere, ma che non sono specifici per alcun programma. Ad esempio, devono essere creati schede alternative per un corso, come MATH 127 e COMSCI 127, nello spazio dei nomi del dominio. Gli alias nello spazio dei nomi del dominio possono essere creati solo dagli amministratori di dominio, ma sono visibili a tutti gli utenti di un dominio.
  • Progetto sviluppatore: lo spazio dei nomi del progetto sviluppatore è utile per gestire gli alias specifici di un'applicazione. Ad esempio, un'applicazione che utilizza identificatori alternativi per i corsi può creare alias per mappare il proprio identificatore ai corsi di Classroom. Gli alias creati in questo spazio dei nomi sono collegati a una console API di Google specifica. Qualsiasi utente di un'applicazione può creare e visualizzare alias nello spazio dei nomi per il progetto sviluppatore di quell'applicazione.

Per ulteriori informazioni sulla gestione dei metadati e degli alias dei corsi, consulta la pagina Gestire i corsi.

Elenchi degli studenti e utenti del corso

Studenti e Insegnanti sono mappature specifiche tra un profilo utente e un corso, che rappresentano il ruolo dell'utente nel corso. Le designazioni di studente e insegnante non sono globali: un utente può essere assegnato come insegnante per un corso e uno studente in un altro. La designazione "studente" o "insegnante" rappresenta un insieme di autorizzazioni per un determinato utente in un determinato corso.

Studenti

Una risorsa per studenti rappresenta un utente iscritto come studente a

per un corso specifico. Gli studenti possono visualizzare i dettagli del corso e gli insegnanti.

Insegnanti

Una risorsa Insegnante rappresenta un utente che tiene un corso specifico.

Gli insegnanti possono visualizzare e modificare i dettagli dei corsi, visualizzare insegnanti e studenti e gestire altri insegnanti e studenti.

Gli inviti e i metodi associati offrono un modo pratico per aggiungere studenti e insegnanti ai corsi. La creazione di inviti consente agli utenti di scegliere se partecipare o meno a un corso, invece di aggiungerli direttamente tramite le risorse per insegnanti e studenti.

UserProfiles rappresenta una mappatura al profilo di dominio di un utente come identificato dall'ID univoco o dall'indirizzo email dell'utente restituito dall' API Directory. L'utente corrente può anche fare riferimento al proprio ID utilizzando l'abbreviazione "me".

Per saperne di più sulla gestione degli elenchi degli studenti, consulta Gestire insegnanti e studenti.

Compiti del corso e compiti consegnati dagli studenti

Un elemento CourseWork rappresenta una singola attività assegnata a un gruppo di studenti in un corso. Contiene dettagli come la descrizione, la data di scadenza e i materiali, nonché metadati come l'ora di creazione. I materiali includono un titolo, una miniatura e un URL, nonché un identificatore che può essere utilizzato con le API appropriate (ad es. Drive, YouTube).

Gli elementi di CourseWork descrivono uno dei seguenti tipi di attività:

  • Un compito che gli studenti completano inviando fogli di lavoro o altri allegati.
  • Una domanda a risposta breve o a scelta multipla.

Il lavoro dello studente per un elemento CourseWork è rappresentato da un StudentSubmission. È costituito da una risposta e metadati aggiuntivi come uno stato e un voto assegnato.

I contenuti di un oggetto StudentSubmission dipendono dal tipo di elemento CourseWork corrispondente:

  • I fogli di lavoro e gli allegati inviati per un compito, inclusi titolo, miniatura e URL, nonché identificatori che possono essere utilizzati con le API appropriate come Drive o YouTube.
  • La risposta a una domanda a risposta breve o a scelta multipla.

Per ulteriori informazioni sulla gestione dei lavori del corso e dei contenuti inviati dagli studenti, consulta Gestire i lavori del corso.

Componenti aggiuntivi di Classroom

Un componente aggiuntivo è un'interfaccia utente e un backend offerti da partner in genere visualizzati in un iframe. I componenti aggiuntivi vengono visualizzati come allegati in un post, ad esempio Announcements, CourseWork o CourseWorkMaterials.

Gli allegati dei componenti aggiuntivi possono essere un'attività o un contenuti.

  • Gli allegati alle attività richiedono che uno studente completi e consegni un invio individuale. Alcuni esempi sono quiz, disegni o giochi. Se vuoi, puoi valutare un invio di un'attività.
  • I contenuti allegati non richiedono l'invio da parte di studenti. Lo studente non deve consegnare l'allegato, che non viene valutato. Alcuni esempi sono foto, articoli e video.

Per ulteriori informazioni, consulta le guide allo sviluppo dei componenti aggiuntivi.

Guide rapide

Per configurare il tuo ambiente e iniziare subito a utilizzare l'API, prova una delle guide rapide:

Sperimenta con Explorer API di Google

Per sperimentare i metodi di chiamata sui dati in tempo reale, prova a utilizzare Explorer API di Google. Non devi scrivere alcun codice per iniziare, ma tieni presente che le azioni eseguite utilizzando Explorer API possono modificare i dati esistenti.

Un modo per iniziare a chiamare i metodi è effettuare una chiamata al metodo courses.list(). Questo metodo non richiede parametri di richiesta e puoi recuperare un id dall'elenco restituito dei corsi da utilizzare come parametro di richiesta per altre chiamate API. Se non hai corsi, puoi crearne uno utilizzando il metodo courses.create().

Puoi anche esplorare il riferimento API.