Bạn có thể tham chiếu các khoá học theo một tên khác bằng tài nguyên Đại diện khoá học. Bí danh khoá học là mối liên kết giữa giá trị nhận dạng khoá học trên Google Lớp học và giá trị nhận dạng khoá học bên ngoài.
Bạn nên sử dụng mã khoá học của SIS làm bí danh cho khoá học bất cứ khi nào bạn tạo khoá học từ SIS hoặc liên kết khoá học với SIS. API Lớp học cho phép bạn thực hiện việc này ngay trong quá trình tạo khoá học bằng cách chỉ định tham số id
của khoá học làm bí danh. Nếu bí danh đã tồn tại, quá trình tạo khoá học sẽ không thành công và bạn sẽ gặp lỗi ALREADY_EXISTS (409)
. Điều này sẽ ngăn việc tạo các khoá học trùng lặp nếu có lỗi trong chương trình đồng bộ hoá.
Có hai loại bí danh: trên toàn miền và trên toàn dự án.
- Bí danh trên toàn miền sử dụng tiền tố
d:
và bất kỳ ai cũng có thể xem được bằng cách sử dụng API Lớp học. - Các bí danh trên toàn dự án sử dụng tiền tố
p:
và chỉ có thể được ứng dụng (dự án bảng điều khiển dành cho nhà phát triển) đã tạo các bí danh đó xem và sử dụng.
Bạn có thể sử dụng bí danh ở bất kỳ vị trí nào trong API yêu cầu giá trị nhận dạng khoá học. Điều này có nghĩa là sau khi đăng ký một bí danh bằng API, bạn có thể sử dụng bí danh đó để đọc và sửa đổi thông tin về khoá học và danh sách lớp học.
Từ góc độ đồng bộ hoá SIS, điều này có nghĩa là giá trị nhận dạng nội bộ của SIS cho một khoá học có thể được đăng ký làm bí danh trên toàn miền cho khoá học đó. Nhờ đó, mọi nhà phát triển tích hợp với cả SIS và Lớp học đều có thể sử dụng giá trị nhận dạng SIS để tương tác với dữ liệu Lớp học.
Ví dụ: giả sử tên SIS là school
và giá trị nhận dạng nội bộ mà SIS sử dụng cho một khoá học cụ thể là math_101
, bạn có thể tạo một bí danh là d:school_math_101
.
Thêm bí danh cho khoá học mới
Để thêm bí danh cho một khoá học mới, hãy đặt course.id
thành bí danh mong muốn khi tạo yêu cầu courses.create()
.
Apps Script
Java
Python
Thêm bí danh cho một khoá học hiện có
Để thêm bí danh trên một khoá học hiện có, bạn có thể đặt alias
thành tên bí danh mong muốn và sử dụng phương thức courses.aliases.create()
.
Apps Script
Java
Python
Truy xuất bí danh của khoá học
Bạn có thể truy xuất các bí danh cho một khoá học bằng phương thức courses.aliases.list()
, như trong mẫu sau:
.NET
Java
Python