Method: domains.domainStats.query

यह फ़ंक्शन, किसी दिए गए डोमेन और समयावधि के लिए, डोमेन के आंकड़ों की सूची वापस लाता है. अगर आपके पास डोमेन के लिए DomainStats को ऐक्सेस करने की अनुमति नहीं है, तो यह PERMISSION_DENIED दिखाता है.

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

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. उस पैरंट संसाधन का नाम जहां आंकड़ों के लिए क्वेरी की गई है. फ़ॉर्मैट: domains/{domain}

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

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
फ़ील्ड
metricDefinitions[]

object (MetricDefinition)

ज़रूरी है. क्वेरी के लिए खास मेट्रिक. हर मेट्रिक के लिए, कस्टम नाम तय किया जा सकता है. इसका इस्तेमाल जवाब में किया जाएगा.
timeQuery

object (TimeQuery)

ज़रूरी है. वह समयावधि या तारीखें जिनके लिए मेट्रिक वापस लानी हैं.
pageSize

integer

ज़रूरी नहीं. जवाब में, ज़्यादा से ज़्यादा कितने DomainStats संसाधन दिखाने हैं. सर्वर, इस वैल्यू से कम नतीजे दिखा सकता है. अगर यह वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट वैल्यू 10 का इस्तेमाल किया जाएगा. ज़्यादा से ज़्यादा 200 वैल्यू डाली जा सकती हैं.
pageToken

string

ज़रूरी नहीं. अगर कोई पिछली सूची का अनुरोध किया गया है, तो उससे मिला nextPageToken वैल्यू. अगर एग्रीगेशन ग्रेन्यूलरिटी DAILY है, तो पेज टोकन, एन्कोड की गई तारीख + "/" + मेट्रिक का नाम होगा. अगर एग्रीगेशन ग्रैन्युलैरिटी OVERALL है, तो पेज टोकन, एन्कोड किया गया मेट्रिक का नाम होगा.
aggregationGranularity

enum (AggregationGranularity)

ज़रूरी नहीं. आंकड़ों को एग्रीगेट करने का लेवल. अगर कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से DAILY पर सेट होता है.

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

कामयाब रहने पर, जवाब के मुख्य हिस्से में QueryDomainStatsResponse का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

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

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

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