- คำขอ 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 |
จำนวนรายการสูงสุดที่จะแสดง 0 หรือไม่ได้ระบุ ระบุว่าเซิร์ฟเวอร์อาจกำหนดค่าสูงสุด เซิร์ฟเวอร์อาจแสดงผลลัพธ์น้อยกว่าจำนวนที่ระบุ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
ตอบกลับเมื่อระบุข้อมูลผู้ปกครอง
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง 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
โปรดดูข้อมูลเพิ่มเติมที่คู่มือการให้สิทธิ์