Method: courses.studentGroups.list

यह फ़ंक्शन, किसी कोर्स में मौजूद ग्रुप की सूची दिखाता है.

यह तरीका, गड़बड़ी के ये कोड दिखाता है:

  • NOT_FOUND अगर कोर्स मौजूद नहीं है.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
courseId

string

ज़रूरी है. कोर्स का आइडेंटिफ़ायर.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

लौटाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. शून्य या कोई वैल्यू न होने का मतलब है कि सर्वर ज़्यादा से ज़्यादा संख्या असाइन कर सकता है. फ़िलहाल, यह संख्या 75 आइटम पर सेट है.

सर्वर, तय की गई संख्या से कम नतीजे दिखा सकता है.
pageToken

string

nextPageToken वैल्यू, पिछली list कॉल से मिली है. इससे पता चलता है कि नतीजों का अगला पेज दिखाया जाना चाहिए.

list अनुरोध, उस अनुरोध से पूरी तरह मेल खाना चाहिए जिससे यह टोकन मिला है.
previewVersion

enum (PreviewVersion)

ज़रूरी नहीं. एपीआई का प्रीव्यू वर्शन. इसे सेट करना ज़रूरी है, ताकि डेवलपर को Preview Program में उपलब्ध कराई गई नई एपीआई सुविधाओं का ऐक्सेस मिल सके.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

छात्र-छात्राओं के ग्रुप की सूची बनाते समय मिला जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

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

ज़्यादा जानकारी के लिए, अनुमति पाने से जुड़ी गाइड देखें.