Bạn có thể tham chiếu các khoá học bằng một tên khác bằng cách sử dụng bí danh khoá học. Bí danh của khoá học có thể đóng vai trò 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. Ví dụ: bạn có thể đặt bí danh cho khoá học để khớp với mã khoá học trong Hệ thống thông tin học sinh (SIS).
Bí danh của khoá học có hai dạng: trên toàn miền và trên toàn dự án.
Biệt hiệu 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ể xem. Không gian tên miền rất hữu ích để tạo các bí danh mà tất cả người dùng cần có quyền truy cập, nhưng không dành riêng cho một chương trình nào. Ví dụ: bạn nên tạo trang thông tin thay thế cho một khoá học, chẳng hạn như MATH 127 và COMSCI 127, trong không gian tên miền. Chỉ quản trị viên miền mới có thể tạo bí danh trong không gian tên miền, nhưng tất cả người dùng trong miền đều có thể nhìn thấy.Biệt hiệu trên toàn dự án sử dụng tiền tố
p:
và chỉ có thể được dự án Google Cloud đã tạo các biệt hiệu đó xem và sử dụng. Không gian tên dự án dành cho nhà phát triển hữu ích cho việc quản lý các bí danh dành riêng cho một ứng dụng. Ví dụ: một ứng dụng sử dụng giá trị nhận dạng thay thế cho các khoá học có thể tạo bí danh để liên kết giá trị nhận dạng của ứng dụng đó với các khoá học trên Lớp học. Các bí danh được tạo trong không gian tên này được liên kết với một dự án Google Cloud cụ thể. Mọi người dùng ứng dụng đều có thể tạo và xem các bí danh trong không gian tên cho dự án nhà phát triển của ứng dụng đó.
Bạn có thể sử dụng bí danh khoá học thay cho mã khoá học trong Lớp học cho mọi điểm cuối API Lớp học. Điều này có nghĩa là 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.
Sử dụng bí danh để đồng bộ hoá với Hệ thống thông tin học sinh
Bạn có thể đăng ký giá trị nhận dạng nội bộ của SIS cho một khoá học dưới dạng bí danh trên toàn miền cho khoá học đó. Bằng cách đó, 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.
Nếu bạn tạo một khoá học từ một SIS hoặc liên kết một khoá học với một SIS, bạn nên sử dụng mã khoá học của SIS làm bí danh của khoá học. Khi tạo một khoá học bằng phương thức courses.create()
, bạn có thể chỉ định bí danh trong trường id
của yêu cầu. 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áo lỗi 409 ALREADY_EXISTS
. Điều này giúp tránh việc tạo khoá học trùng lặp nếu có vấn đề trong chương trình đồng bộ hoá.
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 khi thực hiện 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 trường alias
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 cách sử dụng phương thức courses.aliases.list()
, như trong mẫu sau:
.NET
Java
Python