Method: properties.runRealtimeReport

ב-Google Analytics GT API אפשר לקבל דוח בהתאמה אישית עם נתוני אירועים בזמן אמת לגבי הנכס שלכם. בדוחות האלה מוצגים אירועים ושימוש מ-30 הדקות האחרונות.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
property

string

מזהה של נכס GA4 ב-Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-URL ולא בגוף ההודעה. איפה מוצאים את מזהה הנכס?

דוגמה: properties/1234

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
שדות
dimensions[]

object (Dimension)

המאפיינים המבוקשים ומוצגים.
metrics[]

object (Metric)

המדדים המבוקשים ומוצגים.
limit

string (int64 format)

מספר השורות שיש להחזיר. אם לא מציינים את הפרמטר limit, מוחזרות 10,000 שורות. ה-API מחזיר עד 100,000 שורות לכל בקשה, לא משנה כמה מבקשים.
dimensionFilter

object (FilterExpression)

סעיף הסינון של המאפיינים. חובה לבקש מאפיינים כדי להשתמש במסנן הזה. אי אפשר להשתמש במדדים במסנן הזה.
metricFilter

object (FilterExpression)

סעיף הסינון של המדדים. מיושם בשלב לאחר הצבירה, בדומה לסעיף של SQL. יש לבקש מדדים כדי להשתמש בהם במסנן הזה. אי אפשר להשתמש במאפיינים במסנן הזה.
metricAggregations[]

enum (MetricAggregation)

צבירת מדדים. ערכי המדדים המצטברים יוצגו בשורות שבהן ה-attributeValues מוגדר כ-"RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

מציינת את סדר השורות בתגובה.
returnPropertyQuota

boolean

החלפת מצב אם להחזיר את המצב הנוכחי של מכסת 'זמן אמת' של נכס Analytics הזה. המכסה מוחזרת ב-PropertyQuota.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

טבלת הדוח 'זמן אמת' של התגובה שתואמת לבקשה.

ייצוג JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
שדות
dimensionHeaders[]

object (DimensionHeader)

מתאר עמודות של מאפיינים. מספר 'כותרות המאפיינים' והסדר של 'כותרות מאפיינים' תואמים למאפיינים שמופיעים בשורות.
metricHeaders[]

object (MetricHeader)

תיאור עמודות של מדדים. מספר MetricHeaders והסדר של MetricHeaders תואמים למדדים שמופיעים בשורות.
rows[]

object (Row)

שורות של שילובים של ערכי מאפיינים וערכי מדדים בדוח.
totals[]

object (Row)

אם מתבקשים, ערכי המדדים הכוללים.
maximums[]

object (Row)

הערכים המקסימליים של המדדים, אם צריך.
minimums[]

object (Row)

הערכים המינימליים של המדדים, אם צריך.
rowCount

integer

המספר הכולל של השורות בתוצאת השאילתה, בלי קשר למספר השורות שהוחזרו בתשובה. לדוגמה, אם שאילתה מחזירה 175 שורות וכוללת מגבלת = 50 בבקשת ה-API, התגובה תכיל רק 50 שורות בתור rowCount = 175.
propertyQuota

object (PropertyQuota)

מצב המכסה בזמן אמת של הנכס הזה ב-Analytics, כולל הבקשה הזו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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