Method: properties.runPivotReport

تعرِض هذه الطريقة تقريرًا محوريًا مخصّصًا لبيانات الأحداث في "إحصاءات Google". تُعدّ تقارير Pivot تنسيقات أكثر تقدّمًا وتعبيراً من التقارير العادية. في التقرير المحوري، لا تظهر السمات إلا إذا تم تضمينها في جدول محوري. يمكن تحديد محاور متعدّدة لتقسيم بياناتك بشكل أكبر.

طلب HTTP

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

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

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

المعلمات
property

string

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

مثال: properties/1234

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "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)
    }
  ]
}
الحقول
dimensions[]

object (Dimension)

السمات المطلوبة يجب أن تستخدم إحدى العناصر التالية جميع السمات المحدّدة: dimensionExpression أو dimensionFilter أو pivots أو orderBys.
metrics[]

object (Metric)

المقاييس المطلوبة، ويجب تحديد مقياس واحد على الأقل يجب أن تستخدم إحدى العناصر التالية جميع المقاييس المحدّدة: metric_expression أو metricFilter أو orderBys.
dateRanges[]

object (DateRange)

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

object (Pivot)

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

object (FilterExpression)

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

object (FilterExpression)

عبارة الفلتر الخاصة بالمقاييس. يتم تطبيقها في مرحلة ما بعد التجميع، على غرار عبارة SQL having-clause. يجب طلب استخدام المقاييس في هذا الفلتر. لا يمكن استخدام السمات في هذا الفلتر.
currencyCode

string

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

object (CohortSpec)

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

boolean

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

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

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

boolean

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

object (Comparison)

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

نص الاستجابة

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

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

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

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