Method: courses.students.list

แสดงผลรายชื่อนักเรียนของหลักสูตรนี้ที่ผู้ขอมีสิทธิ์ดู

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

คำขอ HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

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

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

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

string

ตัวระบุของหลักสูตร ตัวระบุนี้อาจเป็นตัวระบุที่ Classroom กำหนดให้หรือ alias ก็ได้

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

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

integer

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

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

string

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

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

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

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

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

ตอบกลับเมื่อแสดงรายชื่อนักเรียน

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

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

object (Student)

นักเรียนที่ตรงกับคำขอในรายชื่อ
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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