REST Resource: courses.aliases

資源:CourseAlias

課程的替代 ID。

別名可明確識別課程。這個名稱不得與下列其中一個範圍重複:

  • 網域:別名建立者網域中的所有使用者都能看見以網域為範圍的別名,而且只能由網域管理員建立。如果課程擁有 Classroom 以外的 ID,系統通常會使用網域範圍別名。

  • 專案:應用程式發出的任何要求中,都會有使用 Developer Console 專案 ID 建立這個別名,且可由任何專案建立,且會顯示專案範圍的別名。當應用程式有替代 ID 時,通常會用到專案範圍的別名。隨機值也可用於避免在傳輸失敗時產生重複的課程,因為如果前一個項目成功執行,重試要求會傳回 ALREADY_EXISTS

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

string

別名字串。字串的格式表示所需的別名範圍。

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

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

方法

create

建立課程別名。

delete

刪除課程別名。

list

傳回課程別名清單。