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

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