Method: courses.studentGroups.list

הפונקציה מחזירה רשימה של קבוצות בקורס.

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

  • ‫NOT_FOUND אם הקורס לא קיים.

בקשת HTTP

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

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

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

פרמטרים
courseId

string

חובה. המזהה של הקורס.

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

פרמטרים
pageSize

integer

מספר הפריטים המקסימלי שיוחזרו. אם לא מציינים ערך או מציינים אפס, השרת יכול להקצות כמות מקסימלית, שמוגדרת כרגע ל-75 פריטים.

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

string

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

הבקשה list צריכה להיות זהה לבקשה שהובילה ליצירת הטוקן הזה.
previewVersion

enum (PreviewVersion)

אופציונלי. גרסת הטרום-השקה של ה-API. ההגדרה הזו נדרשת כדי לקבל גישה ליכולות חדשות של API שזמינות למפתחים בתוכנית ה-Preview.

גוף הבקשה

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

גוף התשובה

תגובה כשמציגים רשימה של קבוצות תלמידים.

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

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

object (StudentGroup)

קבוצות התלמידים.
nextPageToken

string

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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