コース エイリアス リソースを使用すると、別の名前でコースを参照できます。コースのエイリアスは、Google Classroom のコース識別子と外部のコース識別子との間のマッピングです。
SIS からコースを作成する場合や、コースを SIS にリンクする場合は、SIS のコース ID をコースのエイリアスとして使用することをおすすめします。Classroom API を使用すると、コースの id
パラメータをエイリアスとして指定することで、コースの作成時にこれを直接行うことができます。エイリアスがすでに存在する場合、コースの作成は ALREADY_EXISTS (409)
エラーで失敗します。これにより、同期プログラムにバグがある場合に、重複するコースが作成されるのを防ぐことができます。
エイリアスには、ドメイン全体とプロジェクト全体の 2 種類があります。
- ドメイン全体のエイリアスには
d:
という接頭辞が使用され、Classroom API を使用して誰でも見ることができます。 - プロジェクト全体のエイリアスでは
p:
という接頭辞が使用され、エイリアスを作成したアプリケーション(デベロッパー コンソール プロジェクト)のみが表示して使用できます。
エイリアスは、コース識別子が必要な API のあらゆる場所で使用できます。つまり、API を使用してエイリアスを登録すると、そのエイリアスを使用してコースと名簿情報の読み取りと変更を行うことができます。
SIS 同期の観点からは、コースの SIS 内部識別子をコースのドメイン全体のエイリアスとして登録できることを意味します。これにより、SIS と Classroom の両方を統合したデベロッパーは、SIS の ID を使用するだけで Classroom のデータを操作できるようになります。
たとえば、SIS 名が school
で、特定のコースに対して SIS が使用する内部識別子が 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