Method: properties.runRealtimeReport

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

طلب HTTP

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

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

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

المعلمات
property

string

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

مثال: المواقع الإلكترونية/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)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

القيم الإجمالية للمقاييس، إذا لزم الأمر.
maximums[]

object (Row)

يعرض هذا الحقل الحد الأقصى لقيم المقاييس، إذا لزم الأمر.
minimums[]

object (Row)

تمثّل هذه السمة الحد الأدنى لقيم المقاييس، إذا لزم الأمر.
rowCount

integer

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

object (PropertyQuota)

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

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

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

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