Method: properties.runRealtimeReport

הפונקציה מחזירה דוח בהתאמה אישית של נתוני האירועים בזמן אמת לגבי הנכס שלכם. אירועים מופיעים בדוחות בזמן אמת שניות אחרי שהם נשלחים אל Google Analytics. בדוחות 'פעילות בזמן אמת' מוצגים נתוני שימוש ואירועים לפרקי זמן שנעים בין הרגע הנוכחי לבין 30 דקות לפני כן (עד 60 דקות בנכסי Google Analytics 360).

למדריך ליצירת בקשות בזמן אמת להסבר על התשובות, ראו יצירת דוח 'פעילות בזמן אמת'.

בקשת HTTP

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

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

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

פרמטרים
property

string

מזהה של נכס GA4 ב-Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-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)

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

string (int64 format)

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

ה-API יכול גם להחזיר פחות שורות מהערך המבוקש של limit, אם אין ערכי מאפיינים זהים לאלה של limit. לדוגמה, למאפיין country יש פחות מ-300 ערכים אפשריים, ולכן כשמדווחים על country בלבד, אי אפשר לקבל יותר מ-300 שורות, גם אם הגדרתם ל-limit ערך גבוה יותר.
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

החלפת מצב אם להחזיר את המצב הנוכחי של מכסת 'זמן אמת' של נכס Analytics הזה. המכסה מוחזרת ב-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 בבקשת ה-API, התגובה תכיל rowCount מתוך 175 שורות אבל רק 50 שורות.
propertyQuota

object (PropertyQuota)

מצב המכסה בזמן אמת של הנכס הזה ב-Analytics, כולל הבקשה הזו.
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. אפשר להגיש בקשות בטווח של עד 2 דקות.

ייצוג 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. נכסים רגילים של Analytics יכולים לבקש נתוני אירועים מ-30 הדקות האחרונות לכל היותר (startMinutesAgo <= 29), ונכסי Analytics 360 יכולים לבקש נתוני אירועים של עד 60 הדקות האחרונות (startMinutesAgo <= 59).
endMinutesAgo

integer

דקת הסיום הכוללת של השאילתה במספר דקות לפני עכשיו. לא יכול להיות לפני startMinutesAgo. לדוגמה, "endMinutesAgo": 15 מציין שהדוח צריך לכלול נתוני אירועים מלפני 15 דקות לפני כן.

אם לא צוין ערך, ברירת המחדל של endMinutesAgo היא 0. בנכסי Analytics רגילים אפשר לבקש כל דקה מ-30 הדקות האחרונות של נתוני אירועים (endMinutesAgo <= 29). נכסי Analytics 360 יכולים לבקש כל דקה מ-60 הדקות האחרונות של נתוני אירועים (endMinutesAgo <= 59).