Method: courses.topics.list

הפונקציה מחזירה את רשימת הנושאים שהמגיש רשאי להציג.

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
courseId

string

המזהה של הקורס. המזהה הזה יכול להיות המזהה שהוקצה ב-Classroom או alias.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

מספר הפריטים המקסימלי להחזרה. אפס או ערך לא מצוין מצביעים על כך שהשרת עשוי להקצות ערך מקסימלי.

יכול להיות שהשרת יחזיר פחות מהמספר שצוין של תוצאות.
pageToken

string

הערך nextPageToken שהוחזר מקריאה קודמת של list, ומציין שצריך להחזיר את דף התוצאות הבא.

הבקשה list חייבת להיות זהה לזו שהובילה ליצירת האסימון הזה, בכל שאר הפרטים.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

התגובה כשמציגים את הנושאים.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "topic": [
    {
      object (Topic)
    }
  ],
  "nextPageToken": string
}
שדות
topic[]

object (Topic)

פריטים בנושא שתואם לבקשה.
nextPageToken

string

אסימון שמזהה את דף התוצאות הבא להצגה. אם השדה ריק, אין תוצאות נוספות.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/classroom.topics.readonly

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