REST Resource: courses.aliases

資源：CourseAlias

課程的替代 ID。

別名可用來唯一識別課程。在下列任一範圍內不得重複：

  • 網域：網域層級別名可供別名建立者的網域內所有使用者查看，且只能由網域管理員建立。如果課程有 Classroom 以外的 ID，通常會使用網域層級別名。

  • 專案：專案層級別名可供使用建立別名的開發人員控制台專案 ID 所建立的應用程式要求存取，任何專案皆可建立這類別名。應用程式有其他 ID 時，通常會使用專案範圍別名。您也可以使用隨機值，避免在傳輸失敗時重複課程，因為如果先前的傳輸成功，重試要求會傳回 ALREADY_EXISTS。

JSON 表示法 
{
  "alias": string
}
欄位
alias

string

別名字串。字串的格式會指出所需別名的範圍。

  • d:<name> 表示網域層級別名。範例：d:math_101
  • p:<name> 表示專案範圍別名。範例：p:abc123

這個欄位的長度上限為 256 個半形字元。

方法

create

 建立課程的別名。

delete

 刪除課程的別名。

list

 傳回課程別名清單。