Method: courses.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הפונקציה מחזירה רשימה של קורסים שהמשתמש המבקש מורשה להציג, ומוגבלת לקורסים שתואמים לבקשה. הקורס שיוחזרו ממוינים לפי זמן היצירה, והקורס שנוצר לאחרונה יופיע ראשון.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED עבור שגיאות גישה.INVALID_ARGUMENT אם הפורמט של ארגומנט השאילתה שגוי.NOT_FOUND אם משתמשים שצוינו בארגומנטים של השאילתה לא קיימים.
בקשת HTTP
GET https://classroom.googleapis.com/v1/courses
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
| פרמטרים |
studentId |
string
הגבלת הקורסים שיוחזרו רק לקורסים שיש בהם תלמיד/ה עם המזהה שצוין. המזהה יכול להיות אחד מהערכים הבאים:
- המזהה המספרי של המשתמש
- כתובת האימייל של המשתמש
- מחרוזת הליבה
"me", שמציינת את המשתמש המבקש
|
teacherId |
string
ההגדרה הזו מגבילה את הקורסים שיוחזרו רק לקורסים שיש להם מורה עם המזהה שצוין. המזהה יכול להיות אחד מהערכים הבאים:
- המזהה המספרי של המשתמש
- כתובת האימייל של המשתמש
- מחרוזת הליבה
"me", שמציינת את המשתמש המבקש
|
courseStates[] |
enum (CourseState)
הגבלת הקורסים שיוחזרו לאלה שנמצאים באחד מהמצבים שצוינו. ערך ברירת המחדל הוא ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
|
pageSize |
integer
מספר הפריטים המקסימלי להחזרה. אפס או ערך לא מצוין מצביעים על כך שהשרת עשוי להקצות ערך מקסימלי. יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
|
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
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 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)."]]
