REST Resource: courses.aliases

משאב: כינוי לקורס

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

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

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

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

ייצוג JSON 
{
  "alias": string
}
שדות
alias

string

מחרוזת כינוי. פורמט המחרוזת מציין את היקף הכינוי הרצוי.

  • d:<name> מציין כינוי ברמת הדומיין. לדוגמה: d:math_101
  • p:<name> מציין כתובת אימייל חלופית ברמת הפרויקט. לדוגמה: p:abc123

האורך המקסימלי של השדה הוא 256 תווים.

שיטות

create

 יצירת כתובת אימייל חלופית לקורס.

delete

 מחיקת כתובת אימייל חלופית של קורס.

list

 מחזירה רשימת כינויים של קורס.