Method: courses.students.list

इस कोर्स के उन छात्रों की सूची दिखाता है जिन्हें देखने की अनुमति अनुरोध करने वाले व्यक्ति को मिली है.

इस तरीके से, गड़बड़ी के ये कोड मिलते हैं:

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

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

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

पाथ पैरामीटर

पैरामीटर
courseId

string

कोर्स का आइडेंटिफ़ायर. यह आइडेंटिफ़ायर, Classroom से असाइन किया गया आइडेंटिफ़ायर या alias हो सकता है.

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

पैरामीटर
pageSize

integer

ज़्यादा से ज़्यादा कितने आइटम लौटाए जा सकते हैं. अगर कोई वैल्यू नहीं दी गई है या 0 दिया गया है, तो डिफ़ॉल्ट रूप से 30 सेट होता है.

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

string

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

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

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
students[]

object (Student)

सूची के अनुरोध से मेल खाने वाले छात्र-छात्राएं.
nextPageToken

string

नतीजों के अगले पेज की पहचान करने वाला टोकन. अगर यह फ़ील्ड खाली है, तो इसका मतलब है कि कोई और नतीजा उपलब्ध नहीं है.

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

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

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