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)

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

pivots[]

object (Pivot)

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

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

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

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

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

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

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

returnPropertyQuota

boolean

يؤدي هذا الخيار إلى عرض الحالة الحالية لحصة موقع "إحصاءات Google" هذا أو عدم عرضها. يتم عرض الحصة في PropertyQuota.

comparisons[]

object (Comparison)

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