Method: properties.runRealtimeReport

Google Analytics Realtime 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)

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

enum (MetricAggregation)

צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"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, התשובה תכיל את rowCount = 175, אבל רק 50 שורות.
propertyQuota

object (PropertyQuota)

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

היקפי ההרשאות

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

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