Anda dapat mereferensikan kursus dengan nama lain menggunakan resource Alias Kursus. Alias kursus adalah pemetaan antara ID kursus Google Classroom dan ID kursus eksternal.
Sebaiknya setiap kali Anda membuat kursus dari SIS atau menautkan kursus ke
SIS, courseID SIS digunakan sebagai alias kursus. Classroom API
memungkinkan Anda melakukannya langsung dalam pembuatan kursus dengan menentukan parameter id
kursus sebagai alias. Jika alias sudah ada, pembuatan kursus akan gagal
dengan error ALREADY_EXISTS (409)
. Tindakan ini akan mencegah pembuatan kursus
duplikat jika ada bug dalam program sinkronisasi.
Alias tersedia dalam dua jenis: tingkat domain dan tingkat project.
- Alias tingkat domain menggunakan awalan
d:
dan dapat dilihat oleh siapa saja yang menggunakan Classroom API. - Alias seluruh project menggunakan awalan
p:
dan hanya dapat dilihat dan digunakan oleh aplikasi (project konsol developer) yang membuatnya.
Alias dapat digunakan di mana saja dalam API yang mengharapkan ID kursus. Artinya, setelah alias didaftarkan menggunakan API, alias tersebut dapat digunakan untuk membaca dan mengubah informasi kursus dan daftar nama.
Dari perspektif sinkronisasi SIS, hal ini berarti bahwa ID internal SIS untuk kursus dapat didaftarkan sebagai alias seluruh domain untuk kursus tersebut. Dengan begitu, setiap developer yang berintegrasi dengan SIS dan Classroom dapat menggunakan ID SIS untuk berinteraksi dengan data Classroom.
Misalnya, jika kita mengasumsikan nama SIS adalah school
dan ID internal
yang digunakan oleh SIS untuk kursus tertentu adalah math_101
, Anda dapat membuat alias
sebagai d:school_math_101
.
Menambahkan alias untuk kursus baru
Untuk menambahkan alias untuk kursus baru, tetapkan course.id
ke alias yang diinginkan saat
membuat permintaan courses.create()
.
Apps Script
Java
Python
Menambahkan alias untuk kursus yang ada
Untuk menambahkan alias di kursus yang ada, Anda dapat menetapkan alias
ke nama
alias yang diinginkan dan menggunakan metode courses.aliases.create()
.
Apps Script
Java
Python
Mengambil alias kursus
Anda dapat mengambil alias untuk kursus menggunakan
metode courses.aliases.list()
, seperti yang ditunjukkan dalam
contoh berikut:
.NET
Java
Python