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
}
שדות
property

string

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

דוגמה: properties/1234

dimensions[]

object (Dimension)

המאפיינים המבוקשים. כל המאפיינים המוגדרים חייבים להיות בשימוש על ידי אחד מהבאים: dimensionExpression, dimensionFilter, pivots, orderBys.

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

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

pivots[]

object (Pivot)

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

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 לא יהיו שורות eventName: 'purchase' ו-'eventCount': 0.

returnPropertyQuota

boolean

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