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)

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