Method: userProfiles.guardianInvitations.create

สร้างคำเชิญผู้ปกครอง และส่งอีเมลถึงผู้ปกครองเพื่อขอให้ยืนยันว่าเป็นผู้ปกครองของนักเรียน

เมื่อผู้ปกครองตอบรับคำเชิญแล้ว state จะเปลี่ยนเป็น COMPLETED และเริ่มได้รับการแจ้งเตือนผู้ปกครอง นอกจากนี้ ระบบจะสร้างทรัพยากร Guardian เพื่อเป็นตัวแทนของผู้ปกครองที่ใช้งานอยู่ด้วย

ออบเจ็กต์คำขอต้องตั้งค่าช่อง studentId และ invitedEmailAddress การไม่ตั้งค่าช่องเหล่านี้หรือตั้งค่าช่องอื่นๆ ในคำขอจะทำให้เกิดข้อผิดพลาด

เมธอดนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้

  • PERMISSION_DENIEDหากผู้ใช้ปัจจุบันไม่มีสิทธิ์จัดการผู้ปกครอง หากผู้ปกครองที่เป็นปัญหาปฏิเสธคำขอของนักเรียนคนดังกล่าวมากเกินไป ไม่ได้เปิดใช้ผู้ปกครองในโดเมนที่เป็นปัญหา หรือในกรณีที่มีข้อผิดพลาดในการเข้าถึงอื่นๆ
  • RESOURCE_EXHAUSTED ในกรณีที่นักเรียนหรือผู้ปกครองลิงก์ผู้ปกครองเกินขีดจำกัดแล้ว
  • INVALID_ARGUMENT หากอีเมลของผู้ปกครองไม่ถูกต้อง (เช่น ยาวเกินไป) หรือหากระบบระบุรูปแบบบัตรนักศึกษาที่ระบุไม่ได้ (ไม่ใช่อีเมลหรือ userId จาก API นี้) ระบบจะแสดงข้อผิดพลาดนี้ด้วยหากมีการตั้งค่าช่องแบบอ่านอย่างเดียว หรือหากตั้งค่าช่อง state เป็นค่าอื่นที่ไม่ใช่ PENDING
  • NOT_FOUND หากบัตรนักศึกษาที่ระบุเป็นบัตรนักศึกษาที่ถูกต้อง แต่ Classroom ไม่มีข้อมูลบันทึกของนักเรียนคนดังกล่าว
  • ALREADY_EXISTS หากมีคำเชิญผู้ปกครองที่รอการตอบรับสำหรับนักเรียนและ invitedEmailAddress แล้ว หรือหาก invitedEmailAddress ที่ระบุตรงกับบัญชี Google ของ Guardian ที่มีอยู่สำหรับผู้ใช้รายนี้

คำขอ HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
guardianInvitation.studentId

string

บัตรนักศึกษา (ในรูปแบบมาตรฐาน)

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ GuardianInvitation

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ GuardianInvitation ที่สร้างขึ้นใหม่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์