הפונקציה מחזירה דוח בהתאמה אישית של נתוני האירועים ב-Google Analytics. הדוחות מכילים נתונים סטטיסטיים שנגזרים מנתונים שנאספו על ידי קוד המעקב של Google Analytics. הנתונים שמוחזרים מה-API הם כטבלה עם עמודות עבור המאפיינים והמדדים המבוקשים. מדדים הם מדידות בודדות של פעילות המשתמשים בנכס שלכם, כמו משתמשים פעילים או ספירת אירועים. המאפיינים מציגים פירוט של מדדים לפי קריטריונים נפוצים, כמו מדינה או שם אירוע.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1alpha:runReport
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{ "entity": { object ( |
שדות | |
---|---|
entity |
נכס שיש מעקב אחרי האירועים שלו. בתוך בקשה באצווה, הישות הזו צריכה להיות לא מוגדרת או תואמת לישות ברמת האצווה. |
dimensions[] |
המאפיינים המבוקשים והמוצגים. |
metrics[] |
המדדים המבוקשים והוצגו. |
dateRanges[] |
טווחי תאריכים של נתונים לקריאה. אם מבקשים מספר טווחי תאריכים, כל שורת תגובה תכיל אינדקס של טווח תאריכים מבוסס אפס. אם שני טווחי תאריכים חופפים, נתוני האירועים של הימים החופפים נכללים בשורות התגובה של שני טווחי התאריכים. בבקשה לקבוצה בעלת מאפיינים משותפים, חובה לציין |
offset |
מספר השורות בשורת ההתחלה. השורה הראשונה נספרת כשורה 0. |
limit |
מספר השורות שיש להחזיר. אם לא צוין הפרמטר |
metricAggregations[] |
צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"RESERVED_(MetricAggregation)". |
dimensionFilter |
סעיף הסינון של המאפיינים. כדי להשתמש במימדים במסנן הזה, צריך לשלוח בקשה. אי אפשר להשתמש במדדים במסנן הזה. |
metricFilter |
סעיף הסינון של המדדים. היא מיושמת בשלב של צבירה לאחר צבירה (post aggregation), בדומה לתרחיש לדוגמה של SQL. חובה לשלוח בקשה למדדים כדי להשתמש במסנן הזה. אי אפשר להשתמש במימדים במסנן הזה. |
orderBys[] |
מציין את סדר השורות בתשובה. |
currencyCode |
קוד מטבע בפורמט ISO4217, למשל AED, USD, JPY. אם השדה ריק, הדוח ישתמש במטבע ברירת המחדל של הישות. |
cohortSpec |
קבוצה בעלת מאפיינים משותפים שמשויכת לבקשה הזו. אם הבקשה מכילה קבוצה בעלת מאפיינים משותפים, המאפיין 'קבוצה בעלת מאפיינים משותפים' חייב להיכלל בה. |
keepEmptyRows |
אם הערך הוא False או לא צוין, לא תוחזר כל שורה עם כל המדדים שווים ל-0. אם הערך הוא True, השורות האלה יוחזרו אם הן לא הוסרו בנפרד על ידי מסנן. |
returnPropertyQuota |
הלחצן מציין אם להחזיר את המצב הנוכחי של המכסה בנכס Analytics הזה. המכסות מוחזרות ב-PropertyQuota. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של RunReportResponse
.
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics