Puoi fare riferimento ai corsi con un nome diverso utilizzando un alias del corso. Gli alias dei corsi possono fungere da mappatura tra gli identificatori dei corsi di Google Classroom e quelli esterni. Ad esempio, puoi impostare un alias del corso in modo che corrisponda all'ID del corso di un sistema informatico per gli studenti (SIS).
L'alias del corso ha due forme: a livello di dominio e a livello di progetto.
Gli alias a livello di dominio utilizzano il prefisso
d:
e possono essere visualizzati da chiunque utilizzi l'API Classroom. Lo spazio dei nomi del dominio è utile per creare alias a cui tutti gli utenti devono avere accesso, ma che non sono specifici per un determinato programma. Ad esempio, nello spazio dei nomi del dominio devono essere create schede alternative per un corso, come MATH 127 e COMSCI 127. Gli alias nell'espandibilità del dominio possono essere creati solo dagli amministratori di dominio, ma sono visibili a tutti gli utenti di un dominio.Gli alias a livello di progetto utilizzano un prefisso
p:
e possono essere visualizzati e utilizzati solo dal progetto Google Cloud che li ha creati. Lo spazio dei nomi del progetto dello 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 legati a un progetto Google Cloud specifico. Qualsiasi utente di un'applicazione può creare e visualizzare gli alias nello spazio dei nomi per il progetto dello sviluppatore dell'applicazione.
Un alias del corso può essere utilizzato al posto dell'ID del corso di Classroom per qualsiasi endpoint dell'API Classroom. Ciò significa che l'alias può essere utilizzato per leggere e modificare i corsi e le informazioni sugli elenchi degli studenti.
Utilizzare un alias per la sincronizzazione con i sistemi informatici per gli studenti
L'identificatore interno del SIS per un corso può essere registrato come alias a livello di dominio per il corso. In questo modo, qualsiasi sviluppatore che esegue l'integrazione sia con il SIS sia con Classroom può utilizzare l'identificatore SIS per interagire con i dati di Classroom.
Se crei un corso da un SIS o colleghi un corso a un SIS, ti consigliamo di utilizzare l'ID corso del SIS come alias del corso. Quando crei un
corso utilizzando il metodo courses.create()
, puoi specificare l'alias nel
campo id
della richiesta. Se l'alias esiste già, la creazione del corso non va a buon fine con un errore 409 ALREADY_EXISTS
. In questo modo, si evita la creazione di corsi duplicati in caso di problemi con il programma di sincronizzazione.
Ad esempio, se supponiamo che il nome del SIS sia school
e che l'identificatore interno utilizzato dal SIS per un determinato corso sia math_101
, puoi creare un alias come d:school_math_101
.
Aggiungere un alias per un nuovo corso
Per aggiungere un alias per un nuovo corso, imposta course.id
su un alias quando effettui la richiesta courses.create()
.
Apps Script
Java
Python
Aggiungere un alias per un corso esistente
Per aggiungere l'alias a un corso esistente, puoi impostare il campo alias
e utilizzare il metodo courses.aliases.create()
.
Apps Script
Java
Python
Recuperare gli alias dei corsi
Puoi recuperare gli alias di un corso utilizzando il metodo courses.aliases.list()
, come mostrato nell'esempio seguente:
.NET
Java
Python