Method: invitations.list

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

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

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

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

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

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

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

पैरामीटर
userId

string

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

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

string

तय आइडेंटिफ़ायर वाले कोर्स के लिए, 'प्रतिबंधित' सेटिंग वाले न्योते वापस ले आए हैं.
pageSize

integer

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

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

string

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

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

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

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

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

न्योतों की सूची बनाने पर जवाब देना.

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

जेएसओएन के काेड में दिखाना 
{
  "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

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