Method: domainStats.batchQuery

دسته‌ای از درخواست‌های QueryDomainStats را برای چندین دامنه اجرا می‌کند. اگر مجوز دسترسی به DomainStats را برای هر یک از دامنه‌های درخواستی نداشته باشید، مقدار PERMISSION_DENIED را برمی‌گرداند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "requests": [
    {
      object (QueryDomainStatsRequest)
    }
  ]
}
فیلدها
requests[]

object ( QueryDomainStatsRequest )

الزامی. فهرستی از درخواست‌های جستجوی مجزا. هر درخواست می‌تواند برای یک دامنه متفاوت باشد. حداکثر ۱۰۰ درخواست می‌تواند در یک دسته گنجانده شود.

بدنه پاسخ

پیام پاسخ برای 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

درخواست QueryDomainStats

درخواست پیام برای 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 که باید در پاسخ برگردانده شوند. سرور ممکن است کمتر از این مقدار را برگرداند. در صورت عدم تعیین، مقدار پیش‌فرض ۱۰ استفاده خواهد شد. حداکثر مقدار ۲۰۰ است.

pageToken

string

اختیاری. مقدار nextPageToken که از درخواست لیست قبلی، در صورت وجود، بازگردانده می‌شود. اگر جزئیات تجمیع DAILY باشد، توکن صفحه، تاریخ کدگذاری شده + "/" + نام معیار خواهد بود. اگر جزئیات تجمیع OVERALL باشد، توکن صفحه، نام معیار کدگذاری شده خواهد بود.

aggregationGranularity

enum ( AggregationGranularity )

اختیاری. جزئیاتی که آمارها بر اساس آن تجمیع می‌شوند. اگر مشخص نشود، پیش‌فرض روی روزانه است.

نتیجه‌ی BatchQueryDomainStats

نتیجه یک 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 فیلد Union. نتیجه پرس و جوی تکی. result فقط می‌تواند یکی از موارد زیر باشد:
response

object ( QueryDomainStatsResponse )

پاسخ موفقیت‌آمیز برای پرس‌وجوی فردی.

error

object ( Status )

وضعیت خطا در صورت عدم موفقیت در جستجوی فردی.

وضعیت

نوع Status یک مدل خطای منطقی را تعریف می‌کند که برای محیط‌های برنامه‌نویسی مختلف، از جمله REST APIها و RPC APIها، مناسب است. این مدل توسط gRPC استفاده می‌شود. هر پیام Status شامل سه بخش داده است: کد خطا، پیام خطا و جزئیات خطا.

می‌توانید اطلاعات بیشتری در مورد این مدل خطا و نحوه کار با آن را در راهنمای طراحی API بیابید.

نمایش JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
فیلدها
code

integer

کد وضعیت، که باید یک مقدار شمارشی از google.rpc.Code باشد.

message

string

یک پیام خطای مربوط به توسعه‌دهنده که باید به زبان انگلیسی باشد. هرگونه پیام خطای مربوط به کاربر باید بومی‌سازی شده و در فیلد google.rpc.Status.details ارسال شود، یا توسط کلاینت بومی‌سازی شود.

details[]

object

فهرستی از پیام‌هایی که جزئیات خطا را در خود دارند. مجموعه‌ای مشترک از انواع پیام‌ها برای استفاده توسط APIها وجود دارد.