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

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