Method: runPivotReport

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

בקשת HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runPivotReport

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

גוף הבקשה

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

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

object (Entity)

נכס שמתבצע מעקב אחרי האירועים שלו. בבקשה באצווה, הישות הזו צריכה להיות לא מוגדרת או עקבית עם הישות ברמת אצווה.
dimensions[]

object (Dimension)

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

object (Metric)

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

object (FilterExpression)

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

object (FilterExpression)

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

object (Pivot)

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

object (DateRange)

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

string

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

object (CohortSpec)

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

boolean

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

boolean

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

גוף התשובה

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

היקפי הרשאות

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

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