הפונקציה מחזירה דוח צירים בהתאמה אישית של נתוני האירוע ב-Google Analytics. דוחות צירים הם פורמטים מתקדמים ואקספרסיביים יותר מדוחות רגילים. בדוח צירים, המאפיינים מוצגים רק אם הם כלולים בטבלת צירים. אפשר לציין כמה צירים כדי לנתח את הנתונים עוד יותר.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runPivotReport
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
property |
מזהה של נכס GA4 ב-Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-URL ולא בגוף ההודעה. איך מוצאים את מזהה הנכס בתוך בקשה באצווה, המאפיין הזה צריך להיות לא מוגדר או עקבי עם המאפיין ברמת אצווה. דוגמה: properties/1234 |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dimensions": [ { object ( |
שדות | |
---|---|
dimensions[] |
המאפיינים המבוקשים. יש להשתמש בכל המאפיינים המוגדרים לפי אחד מהמאפיינים הבאים: methodExpression, propertyFilter, pivots, orderBys. |
metrics[] |
המדדים המבוקשים. צריך לציין לפחות מדד אחד. צריך להשתמש בכל המדדים המוגדרים לפי אחד מהערכים הבאים: metric_expression, metricFilter, orderBys. |
dateRanges[] |
טווח התאריכים לאחזור נתוני אירועים עבור הדוח. אם מציינים כמה טווחי תאריכים, הדוח ישתמש בנתוני אירועים מכל אחד מטווחי התאריכים. מאפיין מיוחד עם שם השדה dateRange יכולים להיכלל בשמות השדות של ציר; אם הם נכללים, הדוח יש השוואה בין טווחי התאריכים. בבקשת קבוצה בעלת מאפיינים משותפים, צריך לא לציין את ה |
pivots[] |
מתאר את הפורמט החזותי של מאפייני הדוח בעמודות או בשורות. האיחוד של שמות השדות (שמות המאפיינים) בכל הצירים חייב להיות קבוצת משנה של שמות מאפיינים שמוגדרים ב'מאפיינים'. לא ניתן להשתמש בשני צירים עם מאפיין משותף. מאפיין גלוי רק אם הוא מופיע בציר. |
dimensionFilter |
סעיף הסינון של המאפיינים. חובה לבקש מאפיינים כדי להשתמש במסנן הזה. אי אפשר להשתמש במדדים במסנן הזה. |
metricFilter |
סעיף הסינון של המדדים. מיושם בשלב לאחר הצבירה, בדומה לסעיף של SQL. יש לבקש מדדים כדי להשתמש בהם במסנן הזה. אי אפשר להשתמש במאפיינים במסנן הזה. |
currencyCode |
קוד מטבע בפורמט ISO4217, למשל 'AED', 'USD', 'JPY'. אם השדה ריק, הדוח יתבסס על מטבע ברירת המחדל של הנכס. |
cohortSpec |
קבוצה בעלת מאפיינים משותפים שמשויכת לבקשה הזו. אם הבקשה מכילה קבוצה בעלת מאפיינים משותפים, הבקשה כוללת את ה'קבוצה בעלת מאפיינים משותפים' חייב להיות קיים. |
keepEmptyRows |
אם הערך הוא false או לא צוין, לא תוחזר כל שורה שבה כל המדדים שווים ל-0. אם הערך הוא True, השורות האלה יוחזרו אם המסנן לא מסיר אותן בנפרד. בלי קשר להגדרת לדוגמה, אם נכס אף פעם לא מתועד אירוע |
returnPropertyQuota |
החלפת מצב אם להחזיר את המצב הנוכחי של המכסה של נכס Analytics הזה. המכסה מוחזרת ב-PropertyQuota. |
comparisons[] |
זה שינוי אופציונלי. הגדרות ההשוואות המבוקשות והמוצגות. כדי לקבל בתשובה עמודת השוואה, יש צורך גם בשדה 'השוואות' וגם במאפיין 'השוואות'. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של RunPivotReportResponse
.
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics