REST Resource: courses.aliases

• リソース: CourseAlias
  • JSON 表現
• メソッド

リソース: CourseAlias

コースの代替 ID。

コースは一意に識別されます。次のいずれかのスコープ内で一意である必要があります。

• ドメイン: ドメインをスコープとするエイリアスは、エイリアスの作成者のドメイン内のすべてのユーザーが閲覧でき、ドメイン管理者だけが作成できます。ドメイン スコープのエイリアスは、多くの場合、Classroom の外部にコースの ID がある場合に使用します。

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

JSON 表現
{ "alias": string }

フィールド
alias	string エイリアス文字列。文字列の形式は、目的のエイリアス スコープを指定することを示します。 d:<name> は、ドメイン スコープのエイリアスを示します。 例: d:math_101 p:<name> は、プロジェクト スコープのエイリアスを示します。 例: p:abc123 この項目は 256 文字以内で指定してください。

メソッド
create	コースのエイリアスを作成します。
delete	コースのエイリアスを削除します。
list	コースのエイリアスのリストを返します。