Method: properties.runRealtimeReport

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

במאמר יצירת דוח בזמן אמת יש מדריך ליצירת בקשות בזמן אמת ולהבנת התשובות.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

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

פרמטרים
property

string

מזהה של נכס ב-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)

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

string (int64 format)

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

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

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

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

תיאור של עמודות המדדים. מספר הכותרות של המדדים והסדר שלהן תואם למדדים שמוצגים בשורות.
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)

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

string

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

integer

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

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