ส่วนเสริมของ Google Classroom พร้อมให้บริการแก่นักพัฒนาซอฟต์แวร์แล้ว โปรดดูข้อมูลเพิ่มเติมใน
เอกสารส่วนเสริม
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
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 2025-07-25 UTC"],[],[],null,["# Method: courses.students.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListStudentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of students of this course that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n- `NOT_FOUND` if the course does not exist.\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/students`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.students/list#body.ListStudentsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.students/list#google.classroom.v1.Users.ListStudents) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.students/list#google.classroom.v1.Users.ListStudents) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing students.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"students\": [ { object (/workspace/classroom/reference/rest/v1/courses.students#Student) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------|\n| `students[]` | `object (`[Student](/workspace/classroom/reference/rest/v1/courses.students#Student)`)` Students who match the list request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.rosters`\n- `\n https://www.googleapis.com/auth/classroom.rosters.readonly`\n- `\n https://www.googleapis.com/auth/classroom.profile.emails`\n- `\n https://www.googleapis.com/auth/classroom.profile.photos`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
