Method: properties.runPivotReport

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

בקשת HTTP

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

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

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

פרמטרים
property

string

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

דוגמה: properties/1234

גוף הבקשה

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

ייצוג JSON 
{
  "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
}
שדות
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (Pivot)

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

object (FilterExpression)

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

object (FilterExpression)

סעיף הסינון של המדדים. היא מיושמת בשלב של צבירה לאחר צבירה (post aggregation), בדומה לתרחיש לדוגמה של 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.

גוף התשובה

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

היקפי הרשאות

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

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