Method: domains.trafficStats.list

إدراج إحصاءات الزيارات لجميع الأيام المتاحة تعرِض القيمة PERMISSION_DENIED إذا لم يكن لدى المستخدم إذن بالوصول إلى TrafficStats للنطاق.

طلب HTTP

GET https://gmailpostmastertools.googleapis.com/v1/{parent=domains/*}/trafficStats

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
parent

string

اسم المورد للنطاق الذي نريد إدراج إحصاءات زياراته يجب أن يكون على الشكل domains/{domain_name}، حيث يكون domain_name هو اسم النطاق المؤهَّل بالكامل.

مَعلمات طلب البحث

المعلمات
startDate

object (Date)

أقرب يوم للمقاييس التي سيتم استرجاعها. يجب تحديد كلٍّ من startDate وendDate أو عدم تحديد أيٍّ منهما. إذا تم تحديد تاريخ واحد فقط، أو إذا كان تاريخ الانتهاء أقدم من تاريخ البدء، يتم عرض الخطأ INVALID_ARGUMENT.

endDate

object (Date)

آخر يوم من المقاييس التي سيتم استرجاعها حصريًا. يجب تحديد كلٍّ من startDate وendDate أو عدم تحديد أيّ منهما. إذا تم تحديد تاريخ واحد فقط، أو إذا كان تاريخ الانتهاء أقدم من تاريخ البدء، يتم عرض الخطأ INVALID_ARGUMENT.

pageSize

integer

حجم الصفحة المطلوب قد يعرض الخادم عددًا أقل من القيم في مقياس TrafficStats مقارنةً بالعدد المطلوب. إذا لم يتم تحديد قيمة، سيختار الخادم قيمة تلقائية مناسبة.

pageToken

string

قيمة nextPageToken التي تم إرجاعها من طلب List سابق، إن توفّر. هذه هي قيمة ListTrafficStatsResponse.next_page_token التي تم إرجاعها من الطلب السابق إلى طريقة trafficStats.list.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة الردّ على طلب trafficStats.list

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "trafficStats": [
    {
      object (TrafficStats)
    }
  ],
  "nextPageToken": string
}
الحقول
trafficStats[]

object (TrafficStats)

قائمة TrafficStats

nextPageToken

string

رمز مميز لاسترداد الصفحة التالية من النتائج، أو فارغ إذا لم تتوفّر نتائج أخرى في القائمة

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

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

التاريخ

يمثّل تاريخًا تقويميًا كاملاً أو جزئيًا، مثل تاريخ ميلاد. تم تحديد وقت اليوم والمنطقة الزمنية في مكان آخر أو أنّهما غير مهمّين. التاريخ نسبي إلى التقويم الغريغوري. يمكن أن يشير ذلك إلى أحد الخيارات التالية:

  • تاريخ كامل، بقيم غير صفرية للسنة والشهر واليوم
  • الشهر واليوم، مع سنة صفرية (مثلاً، ذكرى سنوية)
  • سنة بمفردها، مع شهر صفري ويوم صفري
  • سنة وشهر، مع يوم صفري (على سبيل المثال، تاريخ انتهاء صلاحية بطاقة الائتمان)

الأنواع ذات الصلة:

تمثيل JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
الحقول
year

integer

السنة التي حدث فيها التاريخ. يجب أن تكون من 1 إلى 9999، أو 0 لتحديد تاريخ بدون عام.

month

integer

الشهر من السنة يجب أن يكون من 1 إلى 12، أو 0 لتحديد سنة بدون شهر ويوم.

day

integer

يوم من الشهر يجب أن يكون من 1 إلى 31 وصالحًا للسنة والشهر، أو 0 لتحديد سنة بمفردها أو سنة وشهر لا يُحتسَب فيها اليوم.