Method: userProfiles.guardianInvitations.list

แสดงผลรายการคำเชิญผู้ปกครองที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยกรองตามพารามิเตอร์ที่มีให้

เมธอดนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้

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

คำขอ HTTP

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

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

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

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

string

รหัสของนักเรียนที่ระบบจะส่งคําเชิญให้ผู้ปกครอง ตัวระบุอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

  • ตัวระบุตัวเลขสำหรับผู้ใช้
  • อีเมลของผู้ใช้
  • สตริงตามตัวอักษร "me" ซึ่งระบุผู้ใช้ที่ส่งคำขอ
  • สตริงตามตัวอักษร "-" ซึ่งบ่งชี้ว่าควรแสดงผลลัพธ์สำหรับนักเรียนทุกคนว่าผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดูคำเชิญผู้ปกครอง

พารามิเตอร์การค้นหา

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

string

หากระบุ ระบบจะแสดงผลเฉพาะผลลัพธ์ที่มี invitedEmailAddress ที่ระบุไว้เท่านั้น
states[]

enum (GuardianInvitationState)

หากระบุ ระบบจะแสดงผลเฉพาะผลลัพธ์ที่มีค่า state ตามที่ระบุ ไม่เช่นนั้น ระบบจะแสดงผลผลลัพธ์ที่มี state เป็น PENDING
pageToken

string

ค่า nextPageToken ที่แสดงผลจากการเรียก list ก่อนหน้า ซึ่งแสดงให้เห็นว่าผลลัพธ์หน้าถัดไปควรถูกส่งคืน

คำขอ list ต้องเหมือนกับคำขอที่ทำให้เกิดโทเค็นนี้
pageSize

integer

จำนวนรายการสูงสุดที่จะส่งคืน ค่าศูนย์หรือไม่ได้ระบุหมายความว่าเซิร์ฟเวอร์สามารถกำหนดค่าสูงสุดได้

เซิร์ฟเวอร์อาจส่งคืนผลลัพธ์น้อยกว่าจำนวนที่ระบุ

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

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

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

ตอบกลับเมื่อแสดงคำเชิญผู้ปกครอง

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
ช่อง
guardianInvitations[]

object (GuardianInvitation)

คำเชิญผู้ปกครองที่ตรงกับคำขอของรายการ
nextPageToken

string

โทเค็นที่ระบุหน้าผลลัพธ์ถัดไปที่จะแสดง หากว่างเปล่า จะไม่มีผลลัพธ์เพิ่มเติม

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

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

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

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