Method: userProfiles.guardianInvitations.list

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

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

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

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