Method: properties.batchRunReports

تعرِض هذه الدالة تقارير متعدّدة في دفعة واحدة. يجب أن تكون جميع التقارير لموقع "إحصاءات Google" نفسه.

طلب HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports

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

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

المعلمات
property

string

معرّف موقع على "إحصاءات Google" يتم تتبُّع أحداثه. يتم تحديدها في مسار عنوان URL وليس في النص. لمزيد من المعلومات، يُرجى الاطّلاع على مكان العثور على رقم تعريف الموقع. يجب تحديد هذه السمة للدفعة. قد تكون السمة ضمن RunReportRequest غير محدّدة أو متّسقة مع هذه السمة.

مثال: properties/1234

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
الحقول
requests[]

object (RunReportRequest)

الطلبات الفردية يتضمّن كل طلب استجابة تقرير منفصلة. يُسمح بحد أقصى 5 طلبات في كل طلب مجمّع.

نص الاستجابة

استجابة الحزمة التي تحتوي على تقارير متعددة

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

تمثيل JSON 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
الحقول
reports[]

object (RunReportResponse)

الردود الفردية يتضمّن كلّ استجابة طلب تقرير منفصل.
kind

string

لتحديد نوع المرجع الذي تنتمي إليه هذه الرسالة. يكون هذا العنصر kind دائمًا السلسلة الثابتة "analyticsData#batchRunReports". وهي مفيدة للتمييز بين أنواع الاستجابات في تنسيق JSON.

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

يتطلب أحد نطاقات OAuth التالية:

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

RunReportRequest

طلب إنشاء تقرير

تمثيل JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
الحقول
property

string

معرّف موقع على "إحصاءات Google" يتم تتبُّع أحداثه. يتم تحديدها في مسار عنوان URL وليس في النص. لمزيد من المعلومات، يُرجى الاطّلاع على مكان العثور على رقم تعريف الموقع. ضمن طلب مجموعة، يجب أن تكون هذه السمة غير محدّدة أو متّسقة مع السمة على مستوى المجموعة.

مثال: properties/1234
dimensions[]

object (Dimension)

السمات المطلوبة والمعروضة
metrics[]

object (Metric)

المقاييس المطلوبة والمعروضة
dateRanges[]

object (DateRange)

النطاقات الزمنية للبيانات المطلوب قراءتها في حال طلب نطاقات زمنية متعددة، سيحتوي كل صف ردّ على فهرس نطاق زمني يستند إلى القيمة صفر. إذا كان نطاقَان زمنيَّان يتداخلان، يتم تضمين بيانات الأحداث للأيّام المتداخلة في صفوف الاستجابة لكلا النطاقَين الزمنيَّين. في طلب مجموعة نموذجية، يجب عدم تحديد هذا الحقل dateRanges.
dimensionFilter

object (FilterExpression)

تتيح لك فلاتر السمات طلب قيم سمات محدّدة فقط في التقرير. لمزيد من المعلومات، اطّلِع على أساسيات فلاتر السمات للحصول على أمثلة. لا يمكن استخدام المقاييس في هذا الفلتر.
metricFilter

object (FilterExpression)

عبارة الفلتر للمقاييس يتم تطبيقها بعد تجميع صفوف التقرير، تمامًا مثل عبارة having في SQL. لا يمكن استخدام السمات في هذا الفلتر.
offset

string (int64 format)

عدد الصفوف في صف البدء. يتم احتساب الصف الأول على أنّه الصف 0.

عند استخدام ميزة تقسيم الصفحات، لا يحدّد الطلب الأول القيمة المرجعية، أو يضبط القيمة المرجعية على 0، ويعرض الطلب الأول أول limit صفًا. يضبط الطلب الثاني البادئة على limit من الطلب الأول، ويعرض الطلب الثاني limit الثاني من الصفوف.

لمزيد من المعلومات عن مَعلمة تقسيم الصفحات هذه، اطّلِع على مقالة تقسيم الصفحات.
limit

string (int64 format)

عدد الصفوف المطلوب عرضها. إذا لم يتم تحديد عدد، يتم عرض 10,000 صف. تعرض واجهة برمجة التطبيقات 250,000 صف كحد أقصى لكل طلب، بغض النظر عن عدد الصفوف التي تطلبها. يجب أن تكون limit موجبة.

يمكن أن تعرِض واجهة برمجة التطبيقات أيضًا عدد صفوف أقل من limit المطلوبة، إذا لم تكن هناك قيم سمات بعدد limit. على سبيل المثال، هناك أقل من 300 قيمة محتملة للسمة country، لذا عند إعداد تقارير عن country فقط، لا يمكنك الحصول على أكثر من 300 صف، حتى إذا ضبطت limit على قيمة أعلى.

لمزيد من المعلومات عن مَعلمة تقسيم الصفحات هذه، اطّلِع على مقالة تقسيم الصفحات.
metricAggregations[]

enum (MetricAggregation)

تجميع المقاييس ستظهر قيم المقاييس المجمّعة في الصفوف التي تم ضبط dimensionValues فيها على RESERVED_(MetricAggregation). سيتم تجميع القيم المجمّعة التي تتضمّن كلّ من المقارنات والنطاقات الزمنية المتعددة استنادًا إلى النطاقات الزمنية.
orderBys[]

object (OrderBy)

تُحدِّد كيفية ترتيب الصفوف في الاستجابة. بالنسبة إلى الطلبات التي تتضمّن مقارنات ونطاقات زمنية متعددة، سيتم تطبيق ترتيب حسب على المقارنات.
currencyCode

string

رمز عملة بتنسيق ISO4217، مثل "AED" أو "USD" أو "JPY" إذا كان الحقل فارغًا، يستخدم التقرير العملة التلقائية للموقع.
cohortSpec

object (CohortSpec)

مجموعة النموذج الأساسي المرتبطة بهذا الطلب. إذا كانت هناك مجموعة نموذجية في الطلب، يجب أن يكون سمة "المجموعة النموذجية" متوفّرة.
keepEmptyRows

boolean

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

بصرف النظر عن إعداد keepEmptyRows هذا، لا يمكن عرض سوى البيانات التي سجّلها موقع "إحصاءات Google" في التقرير.

على سبيل المثال، إذا لم يسجِّل موقع إلكتروني حدث purchase مطلقًا، لن يتضمّن طلب البحث للسمة eventName والمقياس eventCount صفًا باسم الحدث: "purchase" وعدد الأحداث: 0.
returnPropertyQuota

boolean

يتيح هذا الخيار التبديل بين عرض الحالة الحالية لحصة هذا الموقع على "إحصاءات Google" أو عدم عرضها. يتمّ عرض الحصّة في PropertyQuota.
comparisons[]

object (Comparison)

اختيارية: إعدادات المقارنات المطلوبة والمعروضة لا يتطلّب الطلب سوى حقل مقارنات لتلقّي عمود مقارنة في الاستجابة.