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

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