REST Resource: courses.aliases

リソース: CourseAlias

コースの代替識別子。

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

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

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

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

string

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

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

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

Methods

create

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

delete

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

list

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