Method: properties.runRealtimeReport

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

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcoding.

معلّمات المسار

المَعلمات
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 صف. تعرض واجهة برمجة التطبيقات 100,000 صف كحد أقصى لكل طلب، بغض النظر عن العدد الذي تطلبه. يجب أن تكون قيمة limit موجبة.

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

enum (MetricAggregation)

تجميع المقاييس سيتم عرض قيم المقياس المجمّعة في الصفوف التي يتم فيها ضبط قيم ValueTrack على &&;;ERERVED_(MetricAggregation)&quot؛
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)

وصف أعمدة المقاييس يتطابق عدد 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" لهذا الموقع على "إحصاءات Google" بما في ذلك هذا الطلب.
kind

string

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

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

يتطلّب أحد نطاقات OAuth التالية:

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

نطاق الدقيقة

مجموعة متجاورة من الدقائق: 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)، ويمكن أن تطلب مواقع "إحصاءات 360" حتى آخر 60 دقيقة من بيانات الحدث (startMinutesAgo <= 59).
endMinutesAgo

integer

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

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