Method: properties.batchRunPivotReports

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

طلب HTTP

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

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

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

المعلمات
property

string

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

مثال: properties/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" يتم تتبُّع أحداثه. يتم تحديدها في مسار عنوان URL وليس في النص. لمزيد من المعلومات، يُرجى الاطّلاع على مكان العثور على رقم تعريف الموقع. ضمن طلب مجموعة، يجب أن تكون هذه السمة غير محدّدة أو متّسقة مع السمة على مستوى المجموعة.

مثال: properties/1234

dimensions[]

object (Dimension)

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

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

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

pivots[]

object (Pivot)

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

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

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)

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