Method: runReport

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

طلب HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runReport

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

نص الطلب

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

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

object (Entity)

الموقع الذي يتم تتبُّع أحداثه. وفي الطلب المجمّع، يجب أن يكون هذا الكيان غير محدّد أو متسقًا مع الكيان على مستوى الدفعة.
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

string (int64 format)

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

string (int64 format)

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

enum (MetricAggregation)

تجميع المقاييس. ستظهر قيم المقاييس المجمّعة في صفوف تم فيها ضبط قيم السمة على RESERVED_(MetricAggregation)".
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

object (OrderBy)

لتحديد كيفية ترتيب الصفوف في الردّ.
currencyCode

string

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

object (CohortSpec)

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

boolean

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

boolean

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

نص الاستجابة

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

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

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

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