Method: properties.batchRunPivotReports

מחזירה מספר דוחות צירים באצווה. כל הדוחות צריכים להתייחס לאותו נכס GA4.

בקשת HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
property

string

מזהה של נכס GA4 ב-Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-URL ולא בגוף ההודעה. איפה מוצאים את מזהה הנכס? יש לציין את המאפיין הזה עבור הקבוצה. ייתכן שהנכס בתוך RunPivotReportRequest לא צוין או תואם לנכס הזה.

דוגמה: properties/1234

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
שדות
requests[]

object (RunPivotReportRequest)

בקשות אישיות. לכל בקשה יש תגובה נפרדת לדוח צירים. לכל בקשה באצווה יכולות להיות עד 5 בקשות.

גוף התשובה

התגובה באצווה שמכילה כמה דוחות צירים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
שדות
pivotReports[]

object (RunPivotReportResponse)

תשובות אישיות. לכל תשובה יש בקשה נפרדת לדוח צירים.
kind

string

ציון סוג המשאב של ההודעה. הערך kind הוא תמיד המחרוזת הקבועה "analyticsData#batchRunPivotReports". שימושי להבחנה בין סוגי תגובות ב-JSON.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

RunPivotReportRequest

הבקשה ליצירת דוח צירים.

ייצוג JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
שדות
property

string

מזהה של נכס GA4 ב-Google Analytics שיש מעקב אחרי האירועים שלו. מצוין בנתיב כתובת ה-URL ולא בגוף ההודעה. איפה מוצאים את מזהה הנכס? בתוך בקשה באצווה, המאפיין הזה צריך להיות לא מוגדר או עקבי עם המאפיין ברמת אצווה.

דוגמה: properties/1234
dimensions[]

object (Dimension)

המאפיינים המבוקשים. יש להשתמש בכל המאפיינים המוגדרים לפי אחד מהמאפיינים הבאים: methodExpression, propertyFilter, pivots, orderBys.
metrics[]

object (Metric)

המדדים המבוקשים. צריך לציין לפחות מדד אחד. צריך להשתמש בכל המדדים המוגדרים לפי אחד מהערכים הבאים: metric_expression, metricFilter, orderBys.
dateRanges[]

object (DateRange)

טווח התאריכים לאחזור נתוני אירועים עבור הדוח. אם מציינים כמה טווחי תאריכים, הדוח ישתמש בנתוני אירועים מכל אחד מטווחי התאריכים. מאפיין מיוחד עם שם השדה dateRange יכולים להיכלל בשמות השדות של ציר; אם הם נכללים, הדוח יש השוואה בין טווחי התאריכים. בבקשת קבוצה בעלת מאפיינים משותפים, צריך לא לציין את הdateRanges הזה.
pivots[]

object (Pivot)

מתאר את הפורמט החזותי של מאפייני הדוח בעמודות או בשורות. האיחוד של שמות השדות (שמות המאפיינים) בכל הצירים חייב להיות קבוצת משנה של שמות מאפיינים שמוגדרים ב'מאפיינים'. לא ניתן להשתמש בשני צירים עם מאפיין משותף. מאפיין גלוי רק אם הוא מופיע בציר.
dimensionFilter

object (FilterExpression)

סעיף הסינון של המאפיינים. חובה לבקש מאפיינים כדי להשתמש במסנן הזה. אי אפשר להשתמש במדדים במסנן הזה.
metricFilter

object (FilterExpression)

סעיף הסינון של המדדים. מיושם בשלב לאחר הצבירה, בדומה לסעיף של SQL. יש לבקש מדדים כדי להשתמש בהם במסנן הזה. אי אפשר להשתמש במאפיינים במסנן הזה.
currencyCode

string

קוד מטבע בפורמט ISO4217, למשל 'AED', 'USD', 'JPY'. אם השדה ריק, הדוח יתבסס על מטבע ברירת המחדל של הנכס.
cohortSpec

object (CohortSpec)

קבוצה בעלת מאפיינים משותפים שמשויכת לבקשה הזו. אם הבקשה מכילה קבוצה בעלת מאפיינים משותפים, הבקשה כוללת את ה'קבוצה בעלת מאפיינים משותפים' חייב להיות קיים.
keepEmptyRows

boolean

אם הערך הוא False או לא צוין, לא תוחזר כל שורה שבה כל המדדים שווים ל-0. אם הערך הוא True, השורות האלה יוחזרו אם המסנן לא מסיר אותן בנפרד.

בלי קשר להגדרת keepEmptyRows הזו, בדוח יכולים להופיע רק נתונים שתועדו על ידי נכס Google Analytics (GA4).

לדוגמה, אם נכס אף פעם לא מתועד אירוע purchase, בשאילתה של המאפיין eventName ושל המדד eventCount לא יופיע שם האירוע בשורה: "purchase" ו-eventCount: 0.
returnPropertyQuota

boolean

החלפת מצב אם להחזיר את המצב הנוכחי של המכסה של נכס Analytics הזה. המכסה מוחזרת ב-PropertyQuota.
comparisons[]

object (Comparison)

זה שינוי אופציונלי. הגדרות ההשוואות המבוקשות והמוצגות. כדי לקבל בתשובה עמודת השוואה, יש צורך גם בשדה 'השוואות' וגם במאפיין 'השוואות'.