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

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