Method: userProfiles.guardians.list

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

जिस छात्र/छात्रा के लिए अनुरोध करने वाला उपयोगकर्ता, अभिभावक को देख सकता है उसके अभिभावकों की जानकारी देने के लिए, स्टूडेंट आईडी के लिए लिटरल वर्ण - का इस्तेमाल करें.

इस तरीके से गड़बड़ी के ये कोड दिखते हैं:

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

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

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

पाथ पैरामीटर

पैरामीटर
studentId

string

अभिभावक को लिंक किए गए छात्र/छात्रा के हिसाब से फ़िल्टर करें. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाता है
  • स्ट्रिंग लिटरल "-", जो बताता है कि उन सभी छात्र-छात्राओं के लिए नतीजे दिखाए जाने चाहिए जिन्हें देखने का अनुरोध करने वाले उपयोगकर्ता के पास ऐक्सेस है.

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

पैरामीटर
invitedEmailAddress

string

नतीजों को उस ईमेल पते के हिसाब से फ़िल्टर करें जिस पर मूल न्योता भेजा गया था. ऐसा करने पर, यह अभिभावक लिंक दिखेगा. इस फ़िल्टर का इस्तेमाल सिर्फ़ डोमेन एडमिन कर सकते हैं.
pageToken

string

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

list अनुरोध, इस टोकन में मिले अनुरोध के जैसा होना चाहिए.
pageSize

integer

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

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

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

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

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

अभिभावकों की सूची दिखाते समय जवाब देना.

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

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

object (Guardian)

नतीजे दिखाने वाले इस पेज पर मौजूद अभिभावक, जो अनुरोध में बताई गई शर्तों को पूरा करते हैं.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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