Method: courses.aliases.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הפונקציה מחזירה רשימה של כינויים של קורס.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED אם למשתמש המבקש אין הרשאה לגשת לקורס או בגלל שגיאות גישה.NOT_FOUND אם הקורס לא קיים.
בקשת HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים |
courseId |
string
המזהה של הקורס. המזהה הזה יכול להיות המזהה שהוקצה ב-Classroom או alias.
|
פרמטרים של שאילתה
| פרמטרים |
pageSize |
integer
מספר הפריטים המקסימלי להחזרה. אפס או ערך לא מצוין מצביעים על כך שהשרת עשוי להקצות ערך מקסימלי. יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
|
pageToken |
string
הערך nextPageToken שהוחזר מקריאה קודמת של list, ומציין שצריך להחזיר את דף התוצאות הבא. הבקשה list חייבת להיות זהה לזו שהובילה ליצירת האסימון הזה, בכל שאר הפרטים.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תגובה כשמציגים כינויים של קורסים.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"aliases": [
{
object (CourseAlias)
}
],
"nextPageToken": string
} |
| שדות |
aliases[] |
object (CourseAlias)
כינויי הקורס.
|
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.aliases.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.ListCourseAliasesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` The 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. 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.aliases/list#body.ListCourseAliasesResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.aliases/list#google.classroom.v1.Courses.ListCourseAliases) 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 course aliases.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"aliases\": [ { object (/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------|\n| `aliases[]` | `object (`[CourseAlias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias)`)` The course aliases. |\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)."]]
