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

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

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

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

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

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

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

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

การแสดง 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

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