Method: domainStats.batchQuery

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

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

POST https://gmailpostmastertools.googleapis.com/v2beta/domainStats:batchQuery

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

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

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

JSON के काेड में दिखाना 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
फ़ील्ड
requests[]

object (QueryDomainStatsRequest)

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

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

domainStats.batchQuery के लिए जवाब का मैसेज.

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

JSON के काेड में दिखाना 
{
  "results": [
    {
      object (BatchQueryDomainStatsResult)
    }
  ]
}
फ़ील्ड
results[]

object (BatchQueryDomainStatsResult)

जवाबों की सूची. इसमें BatchQueryDomainStatsRequest में मौजूद हर क्वेरी के लिए एक जवाब होता है. जवाबों का क्रम, अनुरोधों के क्रम के हिसाब से होगा.

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

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

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

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

QueryDomainStatsRequest

QueryDomainStats के लिए अनुरोध मैसेज.

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

string

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

object (MetricDefinition)

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

object (TimeQuery)

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

integer

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

string

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

enum (AggregationGranularity)

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

BatchQueryDomainStatsResult

यह बैच में मौजूद किसी एक QueryDomainStatsRequest का नतीजा दिखाता है.

JSON के काेड में दिखाना 
{

  // Union field result can be only one of the following:
  "response": {
    object (QueryDomainStatsResponse)
  },
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
फ़ील्ड
यूनियन फ़ील्ड result. अलग-अलग क्वेरी का नतीजा. result इनमें से सिर्फ़ एक हो सकता है:
response

object (QueryDomainStatsResponse)

किसी क्वेरी का सही रिस्पॉन्स.
error

object (Status)

अगर अलग-अलग क्वेरी पूरी नहीं होती हैं, तो गड़बड़ी का स्टेटस.

स्थिति

Status टाइप, लॉजिकल गड़बड़ी का एक ऐसा मॉडल तय करता है जो अलग-अलग प्रोग्रामिंग एनवायरमेंट के लिए सही होता है. इनमें REST API और RPC API शामिल हैं. इसका इस्तेमाल gRPC करता है. हर Status मैसेज में तीन तरह का डेटा होता है: गड़बड़ी का कोड, गड़बड़ी का मैसेज, और गड़बड़ी की जानकारी.

इस गड़बड़ी के मॉडल और इसके साथ काम करने के तरीके के बारे में ज़्यादा जानने के लिए, एपीआई डिज़ाइन गाइड पढ़ें.

JSON के काेड में दिखाना 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
फ़ील्ड
code

integer

स्टेटस कोड, जो google.rpc.Code की enum वैल्यू होनी चाहिए.
message

string

डेवलपर को दिखने वाला गड़बड़ी का मैसेज, जो अंग्रेज़ी में होना चाहिए. उपयोगकर्ता को दिखने वाली गड़बड़ी के किसी भी मैसेज को स्थानीय भाषा में होना चाहिए. साथ ही, उसे google.rpc.Status.details फ़ील्ड में भेजा जाना चाहिए या क्लाइंट की ओर से स्थानीय भाषा में होना चाहिए.
details[]

object

मैसेज की सूची, जिसमें गड़बड़ी की जानकारी होती है. एपीआई के इस्तेमाल के लिए, मैसेज टाइप का एक सामान्य सेट होता है.