Method: domains.domainStats.query

لیستی از آمار دامنه را برای یک دامنه و دوره زمانی مشخص بازیابی می‌کند. اگر مجوز دسترسی به DomainStats برای دامنه را نداشته باشید، PERMISSION_DENIED را برمی‌گرداند.

درخواست HTTP

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

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

pageToken

string

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

aggregationGranularity

enum ( AggregationGranularity )

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

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از QueryDomainStatsResponse است.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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

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