REST Resource: courses.aliases

ทรัพยากร: CourseAlias

ตัวระบุทางเลือกสำหรับหลักสูตร

ชื่อแทนจะระบุหลักสูตรที่ไม่ซ้ำกัน รหัสต้องไม่ซ้ำกันภายในขอบเขตใดขอบเขตหนึ่งต่อไปนี้

  • โดเมน: ชื่อแทนที่มีขอบเขตระดับโดเมนจะปรากฏแก่ผู้ใช้ทั้งหมดภายในโดเมนของผู้สร้างชื่อแทน และมีเพียงผู้ดูแลระบบโดเมนเท่านั้นที่สามารถสร้างขึ้นได้ ชื่อแทนที่กำหนดขอบเขตระดับโดเมนมักจะใช้เมื่อหลักสูตรมีตัวระบุภายนอก Classroom

  • โปรเจ็กต์: ชื่อแทนระดับโปรเจ็กต์จะปรากฏต่อคำขอจากแอปพลิเคชันที่ใช้รหัสโปรเจ็กต์ Developer Console ที่สร้างชื่อแทนนั้น และสามารถสร้างขึ้นโดยโปรเจ็กต์ใดก็ได้ ชื่อแทนที่กำหนดขอบเขตระดับโปรเจ็กต์มักจะใช้เมื่อแอปพลิเคชันมีตัวระบุสำรอง นอกจากนี้ยังใช้ค่าแบบสุ่มเพื่อหลีกเลี่ยงหลักสูตรที่ซ้ำกันในกรณีที่ส่งข้อมูลไม่สำเร็จได้ด้วย เนื่องจากการส่งคำขออีกครั้งจะส่งกลับ ALREADY_EXISTS หากคำขอก่อนหน้าสำเร็จ

การแสดง JSON 
{
  "alias": string
}
ช่อง
alias

string

สตริงชื่อแทน รูปแบบของสตริงจะระบุขอบเขตของชื่อแทนที่ต้องการ

  • d:<name> หมายถึงชื่อแทนที่กำหนดขอบเขตระดับโดเมน ตัวอย่าง: d:math_101
  • p:<name> บ่งชี้ถึงชื่อแทนที่กำหนดขอบเขตระดับโปรเจ็กต์ ตัวอย่าง: p:abc123

ช่องนี้มีความยาวสูงสุด 256 อักขระ

เมธอด

create

 สร้างชื่อแทนสำหรับหลักสูตร

delete

 ลบชื่อแทนของหลักสูตร

list

 แสดงรายการชื่อแทนสำหรับหลักสูตร