הפונקציה מחזירה דוח בהתאמה אישית של נתוני אירועים בזמן אמת לגבי הנכס שלכם. אירועים מופיעים בדוחות בזמן אמת שניות אחרי שהם נשלחו אל Google Analytics. בדוחות 'זמן אמת' מוצגים אירועים ונתוני שימוש לפרקי זמן, החל מהרגע הנוכחי ועד לפני 30 דקות (עד 60 דקות בנכסי Google Analytics 360).
מדריך ליצירת בקשות בזמן אמת והבנת התגובות זמין במאמר יצירת דוח 'זמן אמת'.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
property |
מזהה נכס GA4 של Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-URL ולא בגוף הטקסט. למידע נוסף, אפשר לעיין במאמר איפה למצוא את מזהה הנכס. דוגמה: properties/1234 |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dimensions": [ { object ( |
שדות | |
---|---|
dimensions[] |
המאפיינים המבוקשים והמוצגים. |
metrics[] |
המדדים המבוקשים והוצגו. |
dimensionFilter |
סעיף הסינון של המאפיינים. אי אפשר להשתמש במדדים במסנן הזה. |
metricFilter |
סעיף הסינון של המדדים. היא מיושמת בשלב של צבירה לאחר צבירה (post aggregation), בדומה לתרחיש לדוגמה של SQL. אי אפשר להשתמש במימדים במסנן הזה. |
limit |
מספר השורות שיש להחזיר. אם לא צוין אחרת, יוחזרו 10,000 שורות. ה-API מחזיר עד 250,000 שורות לבקשה, ללא קשר לכמות שתבקש. הערך כמו כן, ה-API יכול להחזיר פחות שורות מהשדה |
metricAggregations[] |
צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"RESERVED_(MetricAggregation)". |
orderBys[] |
מציין את סדר השורות בתשובה. |
returnPropertyQuota |
קביעה אם להחזיר את המצב הנוכחי של מכסת 'זמן אמת' בנכס Analytics הזה. המכסות מוחזרות ב-PropertyQuota. |
minuteRanges[] |
טווחי הדקות של נתוני אירועים לקריאה. אם לא צוין טווח של דקה אחת ל-30 הדקות האחרונות. אם מבקשים מספר טווחי דקות, כל שורת תגובה תכיל אינדקס של טווחי דקות שמבוסס על אפס. אם יש חפיפה בין שני טווחי דקות, נתוני האירועים של הדקות החופפות נכללים בשורות התגובה של שני טווחי הדקות. |
גוף התשובה
הטבלה של דוח 'זמן אמת' עם תגובה לבקשה.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dimensionHeaders": [ { object ( |
שדות | |
---|---|
dimensionHeaders[] |
מתאר את עמודות המימדים. מספר הכותרות של מימדים והסדר של 'כותרות המאפיינים' תואם למאפיינים שמוצגים בשורות. |
metricHeaders[] |
מתאר עמודות מטריות. מספר הכותרות של MetricHeaders והסדר של MetricHeaders תואם למדדים שנמצאים בשורות. |
rows[] |
שורות של שילובי ערכי מאפיינים וערכי מדדים בדוח. |
totals[] |
אם תתבקשו לעשות זאת, נוכל להציג את הערכים הכוללים של המדדים. |
maximums[] |
אם מתבקשים, הערכים המקסימליים של המדדים. |
minimums[] |
אם התבקשתם לעשות זאת, יוצגו ערכי המדדים המינימליים. |
rowCount |
המספר הכולל של השורות בתוצאת השאילתה. הערך |
propertyQuota |
מצב המכסה בזמן אמת בנכס Analytics הזה, כולל הבקשה הזו. |
kind |
מזהה את סוג המשאב ההודעה הזו. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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 |
הקצאת שם לטווח הדקות הזה. הערך של המאפיין |
startMinutesAgo |
דקת ההתחלה הכוללת של השאילתה כמספר דקות לפני כן. לדוגמה, אם לא צוין, ברירת המחדל של |
endMinutesAgo |
דקת הסיום הכוללת של השאילתה כמספר דקות לפני כן. לא יכול להיות לפני אם לא צוין הערך, ברירת המחדל של |