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. إذا كانت القيمة "صحيح"، سيتم عرض هذه الصفوف إذا لم تتم إزالتها بشكل منفصل من خلال فلتر.
returnPropertyQuota

boolean

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

نص الاستجابة

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

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

يتطلب استخدام أحد نطاقات OAuth التالية:

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