Method: courses.announcements.list

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

कोर्स में शामिल छात्र-छात्राएं सिर्फ़ PUBLISHED सूचनाएं देख सकते हैं. कोर्स के शिक्षक और डोमेन एडमिन, सभी सूचनाएं देख सकते हैं.

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

  • PERMISSION_DENIED अगर अनुरोध करने वाले उपयोगकर्ता को उस कोर्स को ऐक्सेस करने की अनुमति नहीं है जिसके लिए अनुरोध किया गया है या ऐक्सेस से जुड़ी गड़बड़ियों की वजह से.
  • INVALID_ARGUMENT अगर अनुरोध गलत है.
  • NOT_FOUND अगर अनुरोध किया गया कोर्स मौजूद नहीं है.

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

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

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

पाथ पैरामीटर

पैरामीटर
courseId

string

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

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

पैरामीटर
announcementStates[]

enum (AnnouncementState)

दिखाई गई सूचनाओं की संख्या पर पाबंदी.state अगर इस आर्ग्युमेंट की कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट वैल्यू PUBLISHED होगी.
orderBy

string

नतीजों को क्रम से लगाने का विकल्प. फ़ील्ड की कॉमा से अलग की गई सूची, जिसमें क्रम से लगाने के लिए कोई कीवर्ड भी शामिल हो सकता है. यह सुविधा updateTime फ़ील्ड के साथ काम करती है. दिशा के लिए इस्तेमाल किए जा सकने वाले कीवर्ड asc और desc हैं. अगर कोई वैल्यू तय नहीं की गई है, तो डिफ़ॉल्ट रूप से updateTime desc लागू हो जाता है. उदाहरण: updateTime asc, updateTime
pageSize

integer

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

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

string

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

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

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

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

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

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

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

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

object (Announcement)

अनुरोध से मेल खाने वाले सूचना आइटम.
nextPageToken

string

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

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

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

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

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