Method: domainStats.batchQuery

تنفيذ مجموعة من طلبات QueryDomainStats لنطاقات متعددة تعرض الدالة الخطأ PERMISSION_DENIED إذا لم يكن لديك إذن بالوصول إلى DomainStats لأي من النطاقات المطلوبة.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل الترميز إلى 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 التي تم إرجاعها من طلب List سابق، إن وُجدت. إذا كانت دقة التجميع هي 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.
message

string

يشير إلى رسالة خطأ موجّهة للمطوّرين، ويجب أن تكون الرسالة بالإنجليزية. أما رسائل الخطأ الموجّهة للمستخدمين، فيجب ترجمتها وإرسالها في حقل google.rpc.Status.details أو ترجمتها من قِبل العميل.
details[]

object

يشير إلى قائمة بالرسائل التي تتضمّن تفاصيل الخطأ. تتوفّر مجموعة شائعة من أنواع الرسائل التي يمكن لواجهات برمجة التطبيقات استخدامها.