Vous pouvez faire référence à des cours par un autre nom à l'aide d'une ressource d'alias de cours. Les alias de cours correspondent à un mappage entre les identifiants de cours Google Classroom et les identifiants de cours externes.
Nous vous recommandons d'utiliser le code du cours du SIS comme alias de cours chaque fois que vous créez un cours à partir d'un SIS ou que vous associez un cours à un SIS. L'API Classroom vous permet d'effectuer cette opération directement lors de la création du 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 une erreur ALREADY_EXISTS (409)
est renvoyée. Cela évite la création de cours en double en cas de bug dans le programme de synchronisation.
Il existe deux types d'alias: à l'échelle du domaine et à l'échelle du projet.
- Les alias à l'échelle du domaine utilisent le préfixe
d:
et peuvent être vus par tous les utilisateurs de l'API Classroom. - Les alias à l'échelle du projet utilisent un préfixe
p:
et ne peuvent être vus et utilisés que par l'application (projet de la console du développeur) qui les a créés.
Les alias peuvent être utilisés partout dans l'API qui attend 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 cours et les informations sur la liste des participants.
Du point de vue de la synchronisation du SIS, cela signifie que l'identifiant interne du SIS d'un cours peut être enregistré en tant qu'alias à l'échelle du domaine pour le 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 comme d:school_math_101
.
Ajouter un alias pour un nouveau cours
Pour ajouter un alias pour 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 illustré dans l'exemple suivant:
.NET
Java
Python