Method: courses.aliases.list

מחזירה רשימה של כינויים לקורס.

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • PERMISSION_DENIED אם המשתמש ששלח את הבקשה לא מורשה לגשת לקורס או בגלל שגיאות גישה.
  • NOT_FOUND אם הקורס לא קיים.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת 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

למידע נוסף, ניתן לעיין במדריך ההרשאות.