Method: alerts.list

इसमें सूचनाओं की सूची होती है.

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

GET https://alertcenter.googleapis.com/v1beta1/alerts

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

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

पैरामीटर
customerId

string

ज़रूरी नहीं. उस ग्राहक के Google Workspace खाते का यूनीक आइडेंटिफ़ायर जिससे सूचनाएं जुड़ी होती हैं. customerId में शुरू में "C" होना चाहिए हटाया गया (उदाहरण के लिए, 046psxkn). अगर कॉल करने वाले (कॉलर) की पहचान नहीं दी गई है. अपना ग्राहक आईडी ढूंढें.
pageSize

integer

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

string

ज़रूरी नहीं. टोकन, जो नतीजों के उस पेज की पहचान करता है जिसे सर्वर को दिखाना चाहिए. अगर यह फ़ील्ड खाली है, तो नया फिर से शुरू किया जाता है. बार-बार दोहराना जारी रखने के लिए, पिछले ListAlertsResponse के nextPageToken फ़ील्ड से वैल्यू पास करें.
filter

string

ज़रूरी नहीं. सूचना के नतीजों को फ़िल्टर करने के लिए क्वेरी स्ट्रिंग. ज़्यादा जानकारी के लिए, क्वेरी फ़िल्टर और इस्तेमाल किए जा सकने वाले क्वेरी फ़िल्टर फ़ील्ड देखें.
orderBy

string

ज़रूरी नहीं. सूची के नतीजों को क्रम से लगाने का तरीका. अगर तय नहीं किया गया है, तो नतीजे मनचाहे क्रम में दिखाए जा सकते हैं. orderBy="createTime desc" का इस्तेमाल करके, बनाए गए टाइमस्टैंप के हिसाब से नतीजों को घटते क्रम में लगाया जा सकता है. फ़िलहाल, createTime asc, createTime desc, और updateTime desc को क्रम में लगाया जा सकता है

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

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

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

सूचना की लिस्टिंग से जुड़े अनुरोध का जवाब देने के लिए मैसेज.

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

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

object (Alert)

सूचनाओं की सूची.
nextPageToken

string

अगले पेज के लिए टोकन. अगर यूआरएल खाली नहीं है, तो इससे पता चलता है कि लिस्टिंग के अनुरोध से मिलती-जुलती और भी सूचनाएं मिल सकती हैं; इस वैल्यू का इस्तेमाल, अगले ListAlertsRequest में किया जा सकता है, ताकि मौजूदा कॉल के आखिरी नतीजे से सूचनाएं लगातार मिलें.

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

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/apps.alerts

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