Method: properties.runRealtimeReport

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

طلب HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport

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

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

المَعلمات
property

string

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

مثال: Property/1234

نص الطلب

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

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

object (Dimension)

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

object (Metric)

المقاييس المطلوبة وعرضها.
limit

string (int64 format)

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

object (FilterExpression)

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

object (FilterExpression)

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

enum (MetricAggregation)

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

object (OrderBy)

لتحديد كيفية ترتيب الصفوف في الاستجابة.
returnPropertyQuota

boolean

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

جدول تقرير الوقت الفعلي للاستجابة والمقابل لطلب معيّن.

تمثيل JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
الحقول
dimensionHeaders[]

object (DimensionHeader)

لوصف أعمدة الأبعاد. يتطابق عدد أبعاد الأبعاد وترتيب أبعادها مع السمات الموجودة في الصفوف.
metricHeaders[]

object (MetricHeader)

لوصف أعمدة المقاييس. يتطابق عدد MetricHeaders وترتيبها MetricHeaders في المقاييس الموجودة في الصفوف.
rows[]

object (Row)

صفوف مجموعات قيم السمات وقيم المقاييس في التقرير
totals[]

object (Row)

القيم الإجمالية للمقاييس عند طلبها.
maximums[]

object (Row)

الحد الأقصى لقيم المقاييس، عند الطلب.
minimums[]

object (Row)

تمثّل هذه السمة الحد الأدنى لقيم المقاييس، عند الطلب.
rowCount

integer

إجمالي عدد الصفوف في نتيجة طلب البحث، بغض النظر عن عدد الصفوف التي تم عرضها في الاستجابة. على سبيل المثال، إذا عرض طلب بحث 175 صفًا ويتضمن الحد الأقصى = 50 في طلب واجهة برمجة التطبيقات، ستحتوي الاستجابة على rowCount = 175 ولكن فقط 50 صفًا.
propertyQuota

object (PropertyQuota)

حالة الحصة في الوقت الفعلي لهذا الموقع على "إحصاءات Google"، بما في ذلك هذا الطلب.

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

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

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