Method: courses.studentGroups.list

แสดงผลรายชื่อกลุ่มในหลักสูตร

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

  • NOT_FOUND หากไม่มีหลักสูตร

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ตัวระบุของหลักสูตร

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

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

integer

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

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

string

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

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

enum (PreviewVersion)

ไม่บังคับ API เวอร์ชันตัวอย่าง คุณต้องตั้งค่านี้เพื่อเข้าถึงความสามารถใหม่ของ API ที่พร้อมให้บริการแก่นักพัฒนาแอปในโปรแกรมเวอร์ชันตัวอย่าง

เนื้อความของคำขอ

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

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

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

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

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

object (StudentGroup)

กลุ่มนักเรียน
nextPageToken

string

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

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

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

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

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