Method: properties.runRealtimeReport

تعرِض هذه الطريقة تقريرًا مخصّصًا لبيانات الأحداث في الوقت الفعلي لموقعك. تظهر الأحداث في تقارير الوقت الفعلي بعد ثوانٍ من إرسالها إلى "إحصاءات Google". تعرِض تقارير الوقت الفعلي بيانات الأحداث والاستخدام للفترات الزمنية التي تتراوح بين اللحظة الحالية و30 دقيقة مضت (ما يصل إلى 60 دقيقة لمواقع "إحصاءات Google‏ 360").

للحصول على دليل حول إنشاء طلبات الوقت الفعلي وفهم الردود، يُرجى الاطّلاع على مقالة إنشاء تقرير الوقت الفعلي.

طلب HTTP

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

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

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

المعلمات
property

string

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

مثال: properties/1234

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

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

object (Dimension)

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

object (Metric)

المقاييس المطلوبة والمعروضة
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

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

يمكن أن تعرِض واجهة برمجة التطبيقات أيضًا عددًا أقل من الصفوف مقارنةً بـ limit المطلوبة، إذا لم تكن هناك قيم سمات كافية لتلبية limit. على سبيل المثال، هناك أقل من 300 قيمة محتمَلة للسمة country، لذا عند إعداد تقرير عن country فقط، لا يمكنك الحصول على أكثر من 300 صف، حتى إذا ضبطت limit على قيمة أعلى.
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

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

object (MinuteRange)

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

نص الاستجابة

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

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

القيم الإجمالية للمقاييس، إذا تم طلبها
maximums[]

object (Row)

القيم القصوى للمقاييس، إذا تم طلبها
minimums[]

object (Row)

القيم الدنيا للمقاييس، إذا تم طلبها
rowCount

integer

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

object (PropertyQuota)

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

string

يحدّد نوع هذا المورد. تكون قيمة kind دائمًا السلسلة الثابتة "analyticsData#runRealtimeReport". يفيد هذا الحقل في التمييز بين أنواع الاستجابة في JSON.

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

يجب توفير أحد نطاقات OAuth التالية:

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

MinuteRange

مجموعة متجاورة من الدقائق: startMinutesAgo وstartMinutesAgo + 1 و... وendMinutesAgo يُسمح بطلب نطاقَي دقيقة كحدّ أقصى.

تمثيل JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
الحقول
name

string

تحديد اسم لنطاق الدقيقة هذا يتم ضبط قيمة السمة dateRange على هذا الاسم في استجابة التقرير. إذا تم ضبطها، لا يمكن أن تبدأ بـ date_range_ أو RESERVED_. إذا لم يتم ضبطها، يتم تسمية نطاقات الدقيقة حسب الفهرس الذي يبدأ من الصفر في الطلب: date_range_0 وdate_range_1 وما إلى ذلك.
startMinutesAgo

integer

دقيقة البدء الشاملة لطلب البحث كعدد من الدقائق قبل الآن على سبيل المثال، تشير القيمة "startMinutesAgo": 29 إلى أنّ التقرير يجب أن يتضمّن بيانات الأحداث من 29 دقيقة مضت وما بعدها. لا يمكن أن تكون هذه القيمة بعد endMinutesAgo.

إذا لم يتم تحديدها، يتم ضبط startMinutesAgo تلقائيًا على 29. يمكن لمواقع "إحصاءات Google" العادية طلب ما يصل إلى آخر 30 دقيقة من بيانات الأحداث (startMinutesAgo <= 29)، ويمكن لمواقع "إحصاءات Google‏ 360" طلب ما يصل إلى آخر 60 دقيقة من بيانات الأحداث (startMinutesAgo <= 59).
endMinutesAgo

integer

دقيقة الانتهاء الشاملة لطلب البحث كعدد من الدقائق قبل الآن لا يمكن أن تكون هذه القيمة قبل startMinutesAgo. على سبيل المثال، تشير القيمة "endMinutesAgo": 15 إلى أنّ التقرير يجب أن يتضمّن بيانات الأحداث من قبل 15 دقيقة مضت.

إذا لم يتم تحديدها، يتم ضبط endMinutesAgo تلقائيًا على 0. يمكن لمواقع "إحصاءات Google" العادية طلب أي دقيقة في آخر 30 دقيقة من بيانات الأحداث (endMinutesAgo <= 29)، ويمكن لمواقع "إحصاءات Google‏ 360" طلب أي دقيقة في آخر 60 دقيقة من بيانات الأحداث (endMinutesAgo <= 59).