Vous pouvez référencer les cours sous un autre nom grâce à une ressource d'alias de cours. Les alias de cours sont une mise en correspondance entre les identifiants de cours Google Classroom et les identifiants de cours externes.
Chaque fois que vous créez un cours à partir d'un SIS ou que vous associez un cours à un SIS, nous vous recommandons d'utiliser l'ID de cours du SIS comme alias de cours. L'API Classroom vous permet d'effectuer cette opération directement lors de la création d'un cours en spécifiant le paramètre id
du cours en tant qu'alias. Si l'alias existe déjà, la création du cours échoue et génère une erreur ALREADY_EXISTS (409)
. Cela évitera la création de cours en double en cas de bug dans le programme de synchronisation.
Les alias se présentent sous deux formes: à l'échelle du domaine et à l'échelle du projet.
- Les alias au niveau du domaine utilisent le préfixe
d:
et sont visibles par tous les utilisateurs de l'API Classroom. - Les alias à l'échelle du projet utilisent le préfixe
p:
. Ils ne peuvent être vus et utilisés que par l'application (projet de la console pour les développeurs) qui les a créés.
Les alias peuvent être utilisés partout dans l'API qui attendent un identifiant de cours. Cela signifie qu'une fois qu'un alias est enregistré à l'aide de l'API, il peut être utilisé pour lire et modifier les informations sur les cours et les listes d'élèves.
Du point de vue de la synchronisation avec le SIS, cela signifie que l'identifiant interne du SIS d'un cours peut être enregistré en tant qu'alias au niveau du domaine du cours. Ainsi, tout développeur qui intègre à la fois le SIS et Classroom peut simplement utiliser l'identifiant du SIS pour interagir avec les données Classroom.
Par exemple, si nous supposons que le nom du SIS est school
et que l'identifiant interne utilisé par le SIS pour un cours particulier est math_101
, vous pouvez créer un alias sous d:school_math_101
.
Ajouter un alias pour un nouveau cours
Pour ajouter un alias à un nouveau cours, définissez course.id
sur l'alias souhaité lorsque vous effectuez la requête courses.create()
.
Apps Script ;
Java
Python
Ajouter un alias pour un cours existant
Pour ajouter l'alias à un cours existant, vous pouvez définir alias
sur le nom d'alias souhaité et utiliser la méthode courses.aliases.create()
.
Apps Script ;
Java
Python
Récupérer les alias de cours
Vous pouvez récupérer les alias d'un cours à l'aide de la méthode courses.aliases.list()
, comme indiqué dans l'exemple suivant:
.NET
Java
Python