コース エイリアス リソースを使用して、コースを別の名前で参照できます。コース エイリアスは、Google Classroom のコース ID と外部コース ID 間のマッピングです。
SIS からコースを作成するときや、コースを SIS にリンクするときは、SIS の courseID をコース エイリアスとして使用することをおすすめします。Classroom API では、コースの id
パラメータをエイリアスとして指定することで、コースの作成時に直接この操作を行うことができます。エイリアスがすでに存在する場合、コースの作成は失敗し、ALREADY_EXISTS (409)
エラーが発生します。これにより、同期プログラムにバグがある場合に、重複するコースが作成されるのを防ぐことができます。
エイリアスには、ドメイン全体とプロジェクト全体の 2 種類があります。
- ドメイン全体のエイリアスは接頭辞
d:
を使用し、Classroom API を使用するすべてのユーザーが確認できます。 - プロジェクト全体のアリアスは
p:
という接頭辞を使用します。作成したアプリケーション(デベロッパー コンソール プロジェクト)でのみ表示および使用できます。
エイリアスは、コース ID を想定している API のどこでも使用できます。つまり、API を使用してエイリアスを登録すると、そのエイリアスを使用してコースと名簿情報を読み取って変更できるようになります。
SIS 同期の観点から、コースの SIS 内部 ID をコースのドメイン全体のエイリアスとして登録できます。これにより、SIS と Classroom の両方を統合するデベロッパーは、SIS ID を使用して Classroom データに簡単にアクセスできます。
たとえば、SIS 名が school
で、特定のコースに対して SIS で使用される内部 ID が math_101
であると仮定すると、d:school_math_101
というエイリアスを作成できます。
新しいコースのエイリアスを追加する
新しいコースのエイリアスを追加するには、courses.create()
リクエストを行うときに course.id
を目的のエイリアスに設定します。
Apps Script
Java
Python
既存のコースへのエイリアスの追加
既存のコースにアリアスを追加するには、alias
を目的のエイリアス名に設定し、courses.aliases.create()
メソッドを使用します。
Apps Script
Java
Python
コースのエイリアスを取得する
コースのエイリアスを取得するには、次のサンプルに示すように courses.aliases.list()
メソッドを使用します。
.NET
Java
Python