Method: domains.domainStats.query

تعرض هذه الطريقة قائمة بإحصاءات النطاق لنطاق وفترة زمنية محدّدين. تعرض هذه الطريقة الخطأ PERMISSION_DENIED إذا لم يكن لديك إذن بالوصول إلى DomainStats للنطاق.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى 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 التي تم إرجاعها من طلب List سابق، إن وُجدت. إذا كانت دقة التجميع هي DAILY، سيكون رمز الصفحة هو التاريخ المرمّز + "/" + اسم المقياس. إذا كانت دقة التجميع هي OVERALL، سيكون رمز الصفحة هو اسم المقياس المرمّز.
aggregationGranularity

enum (AggregationGranularity)

اختيارية: مستوى التفاصيل الذي سيتم تجميع الإحصاءات عنده. إذا لم يتم تحديدها، يتم ضبط القيمة التلقائية على DAILY.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال QueryDomainStatsResponse.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.