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