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

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