REST Resource: courses.aliases

• משאב: כינוי הקורס
  • ייצוג JSON
• שיטות

משאב: CourseAlias

מזהה חלופי של קורס.

כינוי מזהה קורס באופן ייחודי. היא חייבת להיות ייחודית באחד מההיקפים הבאים:

• דומיין: כינוי ברמת הדומיין גלוי לכל המשתמשים בדומיין של יוצר הכינוי ורק מנהל דומיין יכול ליצור אותו. לרוב משתמשים בכינוי ברמת הדומיין כשיש לקורס מזהה שהוא חיצוני ל-Classroom.

• פרויקט: כינוי ברמת הפרויקט גלוי לכל בקשה מאפליקציה שמשתמשת במזהה הפרויקט ב-Play Console שיצרה את הכינוי, ואפשר ליצור אותו בכל פרויקט. לרוב משתמשים בכינוי ברמת הפרויקט כשלאפליקציה יש מזהים חלופיים. אפשר להשתמש בערך אקראי גם כדי למנוע כפילות של קורסים במקרה של כשל בשידור, כי ניסיון חוזר לשלוח בקשה יחזיר ALREADY_EXISTS אם בקשה קודמת הצליחה.

ייצוג JSON
{ "alias": string }

שדות
alias	string מחרוזת כינוי. הפורמט של המחרוזת מציין את קביעת ההיקף הרצוי של הכינוי. d:<name> מציין כינוי ברמת הדומיין. לדוגמה: d:math_101 p:<name> מציין כינוי ברמת הפרויקט. לדוגמה: p:abc123 האורך המקסימלי של השדה הוא 256 תווים.

שיטות
create	יצירת כינוי לקורס.
delete	מחיקת כינוי של קורס.
list	מחזירה רשימה של כינויים לקורס.