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

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

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

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

चेतावनी वाले पेज के अनुरोध का जवाब देने वाला मैसेज.

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

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

object (Alert)

चेतावनियों की सूची.
nextPageToken

string

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

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

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

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

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