Method: properties.runRealtimeReport

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

لدليل إنشاء طلبات في الوقت الفعلي لفهم الردود، يمكنك الاطّلاع على إنشاء تقرير "الوقت الفعلي".

طلب HTTP

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

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

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

المعلمات
property

string

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

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

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

string (int64 format)

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

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

enum (MetricAggregation)

تجميع المقاييس. ستظهر قيم المقاييس المجمّعة في صفوف تم فيها ضبط قيم السمة على 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 وترتيب DimensionHeaders مع السمات الموجودة في الصفوف.
metricHeaders[]

object (MetricHeader)

تصف أعمدة المقاييس. يتطابق عدد عناوين المقاييس وترتيبها مع المقاييس الواردة في الصفوف.
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.

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

integer

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

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