Google Analytics Realtime API מחזיר דוח בהתאמה אישית של נתוני אירועים בזמן אמת עבור הנכס שלכם. בדוחות האלה מוצגים אירועים ושימוש ב-30 הדקות האחרונות.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
property |
מזהה נכס GA4 של Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-URL ולא בגוף הטקסט. למידע נוסף, אפשר לעיין במאמר איפה למצוא את מזהה הנכס. דוגמה: properties/1234 |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{ "dimensions": [ { object ( |
שדות | |
---|---|
dimensions[] |
המאפיינים המבוקשים והמוצגים. |
metrics[] |
המדדים המבוקשים והוצגו. |
limit |
מספר השורות שיש להחזיר. אם לא צוין הפרמטר |
dimensionFilter |
סעיף הסינון של המאפיינים. כדי להשתמש במימדים במסנן הזה, צריך לשלוח בקשה. אי אפשר להשתמש במדדים במסנן הזה. |
metricFilter |
סעיף הסינון של המדדים. היא מיושמת בשלב של צבירה לאחר צבירה (post aggregation), בדומה לתרחיש לדוגמה של SQL. חובה לשלוח בקשה למדדים כדי להשתמש במסנן הזה. אי אפשר להשתמש במימדים במסנן הזה. |
metricAggregations[] |
צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"RESERVED_(MetricAggregation)". |
orderBys[] |
מציין את סדר השורות בתשובה. |
returnPropertyQuota |
קביעה אם להחזיר את המצב הנוכחי של מכסת 'זמן אמת' בנכס Analytics הזה. המכסות מוחזרות ב-PropertyQuota. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
הטבלה של דוח 'זמן אמת' עם תגובה לבקשה.
ייצוג JSON | |
---|---|
{ "dimensionHeaders": [ { object ( |
שדות | |
---|---|
dimensionHeaders[] |
מתאר את עמודות המימדים. מספר הכותרות של מימדים והסדר של 'כותרות המאפיינים' תואם למאפיינים שמוצגים בשורות. |
metricHeaders[] |
מתאר עמודות מטריות. מספר הכותרות של MetricHeaders והסדר של MetricHeaders תואם למדדים שנמצאים בשורות. |
rows[] |
שורות של שילובי ערכי מאפיינים וערכי מדדים בדוח. |
totals[] |
אם תתבקשו לעשות זאת, נוכל להציג את הערכים הכוללים של המדדים. |
maximums[] |
אם מתבקשים, הערכים המקסימליים של המדדים. |
minimums[] |
אם התבקשתם לעשות זאת, יוצגו ערכי המדדים המינימליים. |
rowCount |
המספר הכולל של השורות בתוצאת השאילתה, ללא קשר למספר השורות שהוחזרו בתגובה. לדוגמה, אם שאילתה מחזירה 175 שורות והיא כוללת מגבלה = 50 בבקשת ה-API, התשובה תכיל את rowCount = 175, אבל רק 50 שורות. |
propertyQuota |
מצב המכסה בזמן אמת בנכס Analytics הזה, כולל הבקשה הזו. |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics