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 وليس في النص. للاطّلاع على مزيد من المعلومات، اطّلِع على مكان العثور على رقم تعريف الموقع.

مثال: Property/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_(تجميع المقاييس)".

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)

لوصف أعمدة الأبعاد. يتطابق عدد AttributeHeaders وترتيب AttributeHeaders مع السمات المتوفّرة في الصفوف.

metricHeaders[]

object (MetricHeader)

وصف أعمدة المقاييس. يتطابق عدد MetricHeaders وترتيب 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#runtimeReport". وهذه البيانات مفيدة للتمييز بين أنواع الردود في 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)، ويمكن أن تطلب مواقع "إحصاءات 360" أي دقيقة خلال آخر 60 دقيقة من بيانات الأحداث (endMinutesAgo <= 59).