Method: properties.runPivotReport

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
property

string

מזהה של נכס 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
שדות
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)

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

string

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

object (CohortSpec)

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

boolean

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

ללא קשר להגדרה keepEmptyRows, רק נתונים שתועדו בנכס Google Analytics יוצגו בדוח.

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

boolean

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

object (Comparison)

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

גוף התשובה

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

היקפי הרשאה

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

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