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

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

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

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