- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ลองใช้งาน
แสดงรายการผู้ปกครองที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดเฉพาะสมาชิกที่ตรงกับคำขอเท่านั้น
หากต้องการแสดงผู้ปกครองของนักเรียนซึ่งผู้ใช้ที่ส่งคำขอสามารถดูผู้ปกครองได้ ให้ใช้อักขระตามจริง -
สำหรับรหัสนักเรียน
เมธอดนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้
PERMISSION_DENIED
หากระบุstudentId
ไว้ และผู้ใช้ที่ส่งคำขอไม่ได้รับอนุญาตให้ดูข้อมูลผู้ปกครองของนักเรียนคนนั้น หากมีการระบุ"-"
เป็นstudentId
และผู้ใช้ไม่ใช่ผู้ดูแลระบบโดเมน หากไม่ได้เปิดใช้ผู้ปกครองในโดเมนที่เป็นปัญหา กรณีที่ตัวกรองinvitedEmailAddress
ตั้งค่าไว้โดยผู้ใช้ที่ไม่ใช่ผู้ดูแลระบบโดเมน หรือกรณีที่ข้อผิดพลาดอื่นๆ ในการเข้าถึงINVALID_ARGUMENT
หากระบุstudentId
แล้ว แต่ระบบไม่รู้จักรูปแบบ (ไม่ใช่อีเมล หรือstudentId
จาก API หรือสตริงตรงตัวme
) อาจส่งคืนได้หากมีการระบุpageToken
ที่ไม่ถูกต้องNOT_FOUND
ถ้าระบุstudentId
ไว้และจดจำรูปแบบได้ แต่ Classroom ไม่มีบันทึกของนักเรียนคนนั้น
คำขอ HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
studentId |
กรองผลลัพธ์ตามนักเรียนที่ลิงก์กับผู้ปกครอง ตัวระบุอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้
|
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
invitedEmailAddress |
กรองผลลัพธ์ตามอีเมลที่ได้รับคำเชิญเดิมซึ่งจะทำให้มีลิงก์สำหรับผู้ปกครองนี้ ตัวกรองนี้สามารถใช้ได้โดยผู้ดูแลระบบโดเมนเท่านั้น |
pageToken |
ค่า คำขอ |
pageSize |
จำนวนรายการสูงสุดที่จะส่งคืน ค่าศูนย์หรือไม่ได้ระบุหมายความว่าเซิร์ฟเวอร์สามารถกำหนดค่าสูงสุดได้ เซิร์ฟเวอร์อาจส่งคืนผลลัพธ์น้อยกว่าจำนวนที่ระบุ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
ตอบกลับเมื่อระบุผู้ปกครอง
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"guardians": [
{
object ( |
ช่อง | |
---|---|
guardians[] |
ผู้ปกครองในหน้าผลการค้นหาที่ตรงกับเกณฑ์ที่ระบุไว้ในคำขอ |
nextPageToken |
โทเค็นที่ระบุหน้าผลลัพธ์ถัดไปที่จะแสดง หากว่างเปล่า จะไม่มีผลลัพธ์เพิ่มเติม |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต 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
สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์