אפשר להפנות לקורסים בשם אחר באמצעות משאב Course Alias. הכינויים של קורסים הם מיפוי בין מזהי הקורסים ב-Google Classroom לבין המזהים החיצוניים.
אנחנו ממליצים שבכל פעם שיוצרים קורס ממערכת SIS או מקשרים קורס למערכת SIS, להשתמש במזהה הקורס במערכת SIS בתור הכינוי של הקורס. אפשר לעשות זאת ישירות ביצירת הקורס באמצעות Classroom API, על ידי ציון הפרמטר id
של הקורס ככינוי. אם הכינוי כבר קיים, יצירת הקורס תיכשל עם הודעת השגיאה ALREADY_EXISTS (409)
. כך לא תוכלו ליצור עותקים כפולים של קורסים אם יהיה באג בתוכנית הסנכרון.
יש שני סוגים של כתובות אימייל חלופיות: ברמת הדומיין וברמת הפרויקט.
- לכינויים ברמת הדומיין יש קידומת
d:
, וכל מי שמשתמש ב-Classroom API יכול לראות אותם. - לכתובות אימייל חלופיות ברמת הפרויקט יש קידומת
p:
, והן גלויות וניתנות לשימוש רק באפליקציה (הפרויקט במסוף הפיתוח) שיצרה אותן.
אפשר להשתמש בכינויים בכל מקום ב-API שבו נדרש מזהה קורס. כלומר, אחרי שמירת כתובת אימייל חלופית באמצעות ה-API, אפשר להשתמש בה כדי לקרוא ולשנות את המידע על קורסים ורשימות של תלמידים.
מנקודת המבט של הסנכרון עם מערכת SIS, המשמעות היא שאפשר לרשום את המזהה הפנימי של הקורס ב-SIS ככתובת חלופית ברמת הדומיין. כך כל מפתח שמשתמש בשילוב של מערכת ה-SIS ו-Classroom יכול פשוט להשתמש במזהה ה-SIS כדי לבצע פעולות עם נתוני Classroom.
לדוגמה, נניח שהשם של מערכת ה-SIS הוא school
והמזהה הפנימי שמערכת ה-SIS משתמשת בו לקורס מסוים הוא math_101
. אפשר ליצור כינוי בשם d:school_math_101
.
הוספת כינוי לקורס חדש
כדי להוסיף כינוי לכיתה חדשה, מגדירים את course.id
לכינוי הרצוי כששולחים את הבקשה courses.create()
.
Apps Script
Java
Python
הוספת כינוי לכיתה קיימת
כדי להוסיף את הכינוי לקורס קיים, אפשר להגדיר את alias
לשם הכינוי הרצוי ולהשתמש בשיטה courses.aliases.create()
.
Apps Script
Java
Python
אחזור של כינויים של קורסים
אפשר לאחזר את כינויי המשנה של קורס באמצעות ה-method courses.aliases.list()
, כפי שמתואר בדוגמה הבאה:
.NET
Java
Python