REST Resource: courses.aliases

リソース: CourseAlias

コースの代替 ID。

エイリアスはコースを一意に識別します。次のいずれかのスコープ内で一意である必要があります。

  • domain: ドメイン スコープのエイリアスは、エイリアスの作成者のドメイン内のすべてのユーザーに表示され、ドメイン管理者のみ作成できます。ドメイン スコープのエイリアスは、コースに Classroom 外部の ID がある場合によく使用されます。

  • project: プロジェクト スコープのエイリアスは、エイリアスを作成した Developer Console プロジェクト ID を使用するアプリケーションからのすべてのリクエストに表示され、任意のプロジェクトによって作成できます。プロジェクト スコープのエイリアスは、アプリケーションに代替の識別子がある場合によく使用されます。ランダムな値を使用すると、転送に失敗した場合にコースが重複するのを回避することもできます。リクエストを再試行すると、前のリクエストが成功した場合は ALREADY_EXISTS が返されます。

JSON 表現 
{
  "alias": string
}
フィールド
alias

string

エイリアス文字列。文字列の形式は、必要なエイリアスのスコープを示します。

  • d:<name> はドメイン スコープのエイリアスを示します。例: d:math_101
  • p:<name> はプロジェクト スコープのエイリアスを示します。例: p:abc123

このフィールドの最大長は 256 文字です。

メソッド

create

 コースのエイリアスを作成します。

delete

 コースのエイリアスを削除します。

list

 コースのエイリアスのリストを返します。