Method: invitations.list

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

ध्यान दें: userId या courseId में से कम से कम एक वैल्यू देना ज़रूरी है. दोनों फ़ील्ड की जानकारी दी जा सकती है.

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

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

GET https://classroom.googleapis.com/v1/invitations

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

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

पैरामीटर
userId

string

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

  • उपयोगकर्ता का अंकों वाला आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जिससे अनुरोध करने वाले उपयोगकर्ता के बारे में पता चलता है
courseId

string

यह फ़ंक्शन, दिखाए गए नतीजों में सिर्फ़ उन न्योतों को शामिल करता है जो दिए गए आइडेंटिफ़ायर वाले कोर्स के लिए हैं.
pageSize

integer

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

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

string

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

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

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

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

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

न्योते की सूची बनाते समय मिलने वाला जवाब.

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

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

object (Invitation)

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

string

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

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

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

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

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