Puoi fare riferimento ai corsi con un nome diverso con una risorsa Alias corso. Gli alias del corso sono una mappatura tra gli identificatori dei corsi di Google Classroom e quelli esterni dei corsi.
Ogni volta che 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. L'API Classroom
consente di eseguire questa operazione direttamente durante la creazione del corso specificando il parametro id
del corso come alias. Se l'alias esiste già, la creazione del corso non andrà a buon fine e verrà visualizzato un errore ALREADY_EXISTS (409)
. In questo modo eviterai la creazione di corsi duplicati se c'è un bug nel programma di sincronizzazione.
Gli alias possono essere di due tipi: a livello di dominio e a livello di progetto.
- Gli alias a livello di dominio utilizzano un prefisso
d:
e possono essere visualizzati da chiunque utilizzi l'API Classroom. - Gli alias a livello di progetto utilizzano un prefisso
p:
e possono essere visualizzati e utilizzati solo dall'applicazione (progetto della console per gli sviluppatori) che li ha creati.
Gli alias possono essere utilizzati ovunque nell'API che prevede un identificatore del corso. Ciò significa che, una volta registrato un alias tramite l'API, l'alias può essere utilizzato per leggere e modificare le informazioni sui corsi e sull'elenco degli studenti.
Dal punto di vista della sincronizzazione del SIS, ciò significa che l'identificatore interno del SIS di un corso può essere registrato come alias a livello di dominio per il corso. In questo modo, qualsiasi sviluppatore che si integra sia con il SIS sia con Classroom può semplicemente utilizzare l'identificatore del SIS per interagire con i dati di Classroom.
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
, potresti 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
sull'alias desiderato quando
invii 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 alias
sul nome
alias desiderato e utilizzare il metodo courses.aliases.create()
.
Apps Script
Java
Python
Recuperare gli alias del corso
Puoi recuperare gli alias per un corso utilizzando il metodo courses.aliases.list()
, come mostrato nel seguente esempio:
.NET
Java
Python