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

 傳回課程別名清單。