REST Resource: courses.aliases

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

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

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

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

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

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

string

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

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

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

วิธีการ

create

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

delete

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

list

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