Method: properties.batchRunPivotReports

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

طلب HTTP

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

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

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

المعلمات
property

string

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

مثال: المواقع الإلكترونية/1234

نص الطلب

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

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

object (RunPivotReportRequest)

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

نص الاستجابة

الرد المجمّع الذي يحتوي على عدة تقارير محورية.

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

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

object (RunPivotReportResponse)

الردود الفردية يحتوي كل رد على طلب تقرير محوري منفصل.

kind

string

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

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

RunPivotReportRequest

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

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

string

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

مثال: المواقع الإلكترونية/1234

dimensions[]

object (Dimension)

السمات المطلوبة. يجب استخدام جميع الأبعاد المحدَّدة بواسطة أحد العناصر التالية: dimensionExpression وdimensionFilter وPivots وorderBys.

metrics[]

object (Metric)

المقاييس المطلوبة، يجب تحديد مقياس واحد على الأقل. يجب استخدام جميع المقاييس المحدَّدة بواسطة أحد الأنواع التالية: Metrics_expression وMetricFilter وorderBys.

dateRanges[]

object (DateRange)

النطاق الزمني المطلوب من أجل استرداد بيانات الأحداث للتقرير. في حال تحديد نطاقات زمنية متعددة، يتم استخدام بيانات الأحداث من كل نطاق زمني في التقرير. بُعد خاص يحمل اسم الحقل "dateRange" يمكن تضمينها في أسماء حقول المحور المحوري؛ في حال تضمينه، يقارن التقرير بين النطاقات الزمنية. في طلب المجموعة النموذجية، يجب عدم تحديد قيمة dateRanges هذه.

pivots[]

object (Pivot)

يصف التنسيق المرئي لأبعاد التقرير في الأعمدة أو الصفوف. يجب أن يكون اتحاد fieldNames (أسماء السمات) في جميع النقاط المحورية مجموعة فرعية من أسماء السمات المحددة في "الأبعاد". لا يمكن أن يتشارك أي محوريَين في أحد السمات. لا تظهر السمة إلا إذا ظهرت في شكل محوري.

dimensionFilter

object (FilterExpression)

عبارة الفلتر للأبعاد. يجب طلب استخدام المكوّنات في هذا الفلتر. لا يمكن استخدام المقاييس في هذا الفلتر.

metricFilter

object (FilterExpression)

عبارة تصفية المقاييس. يُطبق في مرحلة ما بعد التجميع، على غرار وجود عبارة SQL. يجب طلب استخدام المقاييس في هذا الفلتر. لا يمكن استخدام الأبعاد في هذا الفلتر.

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

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

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

returnPropertyQuota

boolean

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

comparisons[]

object (Comparison)

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