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_(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 وترتيبها 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).