คุณสามารถอ้างอิงหลักสูตรโดยใช้ชื่ออื่นได้ด้วยทรัพยากรชื่อแทนของหลักสูตร อีเมลแทนของหลักสูตรคือการแมประหว่างตัวระบุหลักสูตร Google Classroom กับตัวระบุหลักสูตรภายนอก
เราขอแนะนำให้ใช้รหัสหลักสูตรของ SIS เป็นอีเมลแทนของหลักสูตรทุกครั้งที่คุณสร้างหลักสูตรจาก SIS หรือลิงก์หลักสูตรกับ SIS Classroom API ช่วยให้คุณดำเนินการนี้โดยตรงในการสร้างหลักสูตรได้โดยระบุพารามิเตอร์ id
ของหลักสูตรเป็นอีเมลแทน หากมีอีเมลแทนอยู่แล้ว การสร้างหลักสูตรจะล้มเหลวพร้อมข้อผิดพลาด ALREADY_EXISTS (409)
วิธีนี้จะช่วยป้องกันไม่ให้มีการสร้างหลักสูตรที่ซ้ำกันหากโปรแกรมการซิงค์มีข้อบกพร่อง
นามแฝงมี 2 ประเภท ได้แก่ ทั่วทั้งโดเมนและทั่วทั้งโปรเจ็กต์
- อีเมลแทนทั่วทั้งโดเมนจะใช้คำนำหน้า
d:
และทุกคนที่ใช้ Classroom API จะดูอีเมลแทนนี้ได้ - โดยชื่อแทนทั่วทั้งโปรเจ็กต์จะใช้คำนำหน้า
p:
และจะมีเพียงแอปพลิเคชัน (โปรเจ็กต์ในคอนโซลของนักพัฒนาซอฟต์แวร์) ที่สร้างชื่อแทนดังกล่าวเท่านั้นที่จะเห็นและใช้ชื่อแทนนั้นได้
คุณสามารถใช้อีเมลแทนได้ทุกที่ใน API ที่คาดหวังตัวระบุหลักสูตร ซึ่งหมายความว่าเมื่อลงทะเบียนอีเมลแทนโดยใช้ API แล้ว อีเมลแทนนั้นจะใช้อ่านและแก้ไขข้อมูลหลักสูตรและข้อมูลบัญชีรายชื่อได้
จากมุมมองการซิงค์ SIS การดำเนินการนี้หมายความว่าตัวระบุภายในของ SIS สำหรับหลักสูตรสามารถจดทะเบียนเป็นชื่อแทนสำหรับทั้งโดเมนของหลักสูตรได้ วิธีนี้จะช่วยให้นักพัฒนาแอปที่ผสานรวมกับทั้ง SIS และ Classroom สามารถใช้ตัวระบุ SIS เพื่อโต้ตอบกับข้อมูล Classroom ได้
ตัวอย่างเช่น หากสมมติว่าชื่อ SIS คือ school
และตัวระบุภายในที่ SIS ใช้สำหรับหลักสูตรหนึ่งๆ คือ math_101
คุณอาจสร้างอีเมลแทนเป็น d:school_math_101
เพิ่มชื่อแทนสำหรับหลักสูตรใหม่
หากต้องการเพิ่มอีเมลแทนสำหรับหลักสูตรใหม่ ให้ตั้งค่า course.id
เป็นอีเมลแทนที่ต้องการเมื่อส่งคำขอ courses.create()
Apps Script
Java
Python
เพิ่มอีเมลแทนสำหรับหลักสูตรที่มีอยู่
หากต้องการเพิ่มอีเมลแทนในหลักสูตรที่มีอยู่ ให้ตั้งค่า alias
เป็นอีเมลแทนที่ต้องการ แล้วใช้เมธอด courses.aliases.create()
Apps Script
Java
Python
ดึงข้อมูลอีเมลแทนของหลักสูตร
คุณสามารถเรียกข้อมูลอีเมลแทนสำหรับหลักสูตรได้โดยใช้เมธอด courses.aliases.list()
ดังที่แสดงในตัวอย่างต่อไปนี้
.NET
Java
Python