Method: userProfiles.guardians.get

แสดงผลผู้ปกครองที่ต้องการ

โดยวิธีส่งคืนรหัสข้อผิดพลาดต่อไปนี้

  • PERMISSION_DENIED หากผู้ใช้ที่ต้องการจับคู่ studentId ที่ให้มาไม่เห็นผู้ใช้ที่ส่งคําขอไม่ได้รับอนุญาตให้ดูข้อมูลผู้ปกครองของนักเรียนที่ studentId ระบุ หากไม่ได้เปิดใช้โดเมนที่เป็นปัญหาหรือข้อผิดพลาดในการเข้าถึงอื่นๆ
  • INVALID_ARGUMENT หากระบุ studentId ไว้ แต่ระบบไม่รู้จักรูปแบบดังกล่าว (ไม่ใช่อีเมล หรือ studentId จาก API หรือสตริงตามตัวอักษร me)
  • NOT_FOUND หากผู้ใช้ที่ส่งคําขอได้รับอนุญาตให้ดูผู้ปกครองสําหรับ studentId ที่ส่งคําขอ แต่ไม่พบระเบียน Guardian ของนักเรียนที่ตรงกับ guardianId ที่ให้ไว้

คำขอ HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

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

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

string

นักเรียนที่ผู้ปกครองเป็นผู้ขอ ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้

  • ตัวระบุที่เป็นตัวเลขสําหรับผู้ใช้
  • อีเมลของผู้ใช้
  • สตริงตามตัวอักษร "me" ซึ่งระบุผู้ใช้ที่ส่งคําขอ
guardianId

string

ช่อง id จาก Guardian

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

เนื้อหาของคำขอต้องว่างเปล่า

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Guardian

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

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

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

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อภาพรวม OAuth 2.0