ส่วนเสริมของ Google Classroom พร้อมให้บริการแก่นักพัฒนาซอฟต์แวร์แล้ว โปรดดูข้อมูลเพิ่มเติมใน
เอกสารส่วนเสริม
Method: courses.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
แสดงรายการหลักสูตรที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดไว้เฉพาะหลักสูตรที่ตรงกับคำขอ ระบบจะจัดเรียงหลักสูตรที่แสดงตามเวลาที่สร้าง โดยหลักสูตรที่สร้างล่าสุดจะแสดงก่อน
วิธีการนี้จะแสดงรหัสข้อผิดพลาดต่อไปนี้
PERMISSION_DENIED สำหรับข้อผิดพลาดในการเข้าถึงINVALID_ARGUMENT หากอาร์กิวเมนต์การค้นหามีรูปแบบไม่ถูกต้องNOT_FOUND หากไม่มีผู้ใช้ที่ระบุไว้ในอาร์กิวเมนต์การค้นหา
คำขอ HTTP
GET https://classroom.googleapis.com/v1/courses
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
| พารามิเตอร์ |
studentId |
string
จำกัดหลักสูตรที่แสดงผลไว้เฉพาะหลักสูตรที่มีนักเรียนที่มีตัวระบุที่ระบุ ตัวระบุอาจเป็นค่าใดค่าหนึ่งต่อไปนี้
- ตัวระบุตัวเลขของผู้ใช้
- อีเมลของผู้ใช้
- สตริงตามตัวอักษร
"me" ที่ระบุผู้ใช้ที่ส่งคำขอ
|
teacherId |
string
จำกัดหลักสูตรที่แสดงผลไว้เฉพาะหลักสูตรที่มีครูซึ่งมีตัวระบุที่ระบุ ตัวระบุอาจเป็นค่าใดค่าหนึ่งต่อไปนี้
- ตัวระบุตัวเลขของผู้ใช้
- อีเมลของผู้ใช้
- สตริงตามตัวอักษร
"me" ที่ระบุผู้ใช้ที่ส่งคำขอ
|
courseStates[] |
enum (CourseState)
จำกัดหลักสูตรที่แสดงผลไว้เฉพาะหลักสูตรที่อยู่ในสถานะที่ระบุ ค่าเริ่มต้นคือ "ใช้งานอยู่" "เก็บถาวร" "จัดสรรแล้ว" "ถูกปฏิเสธ"
|
pageSize |
integer
จำนวนรายการสูงสุดที่จะแสดง 0 หรือไม่ระบุหมายความว่าเซิร์ฟเวอร์อาจกำหนดค่าสูงสุด เซิร์ฟเวอร์อาจแสดงผลลัพธ์น้อยกว่าจำนวนที่ระบุ
|
pageToken |
string
ค่า nextPageToken ที่แสดงผลจากการเรียก list ก่อนหน้า ซึ่งระบุว่าควรแสดงผลหน้าผลการค้นหาถัดไป คําขอ list ต้องเหมือนกับคําขอที่ทําให้เกิดโทเค็นนี้
|
เนื้อความของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบสนองเมื่อแสดงข้อมูลหลักสูตร
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
{
"courses": [
{
object (Course)
}
],
"nextPageToken": string
} |
| ช่อง |
courses[] |
object (Course)
หลักสูตรที่ตรงกับคำขอรายการ
|
nextPageToken |
string
โทเค็นที่ระบุหน้าถัดไปของผลการค้นหาที่จะแสดง หากช่องนี้ว่างเปล่า แสดงว่าไม่มีผลการค้นหาเพิ่มเติม
|
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 2025-07-25 UTC"],[],[],null,["# Method: courses.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCoursesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the query argument is malformed.\n- `NOT_FOUND` if any users specified in the query arguments do not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `studentId` | `string` Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `teacherId` | `string` Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n| `courseStates[]` | `enum (`[CourseState](/workspace/classroom/reference/rest/v1/courses#CourseState)`)` Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses/list#body.ListCoursesResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses/list#google.classroom.v1.Courses.ListCourses) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses/list#google.classroom.v1.Courses.ListCourses) 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 courses.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"courses\": [ { object (/workspace/classroom/reference/rest/v1/courses#Course) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------|\n| `courses[]` | `object (`[Course](/workspace/classroom/reference/rest/v1/courses#Course)`)` Courses that 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.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
