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