Method: properties.batchRunPivotReports

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

בקשת HTTP

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

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

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

פרמטרים
property

string

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

דוגמה: properties/1234

גוף הבקשה

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

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

object (RunPivotReportRequest)

בקשות פרטניות. לכל בקשה יש תגובה נפרדת של דוח ציר. כל בקשת Batch יכולה לכלול עד 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

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

דוגמה: 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 (שמות המאפיינים) בכל הצירים חייב להיות קבוצת משנה של שמות המאפיינים שמוגדרים ב-Dimensions. אי אפשר להשתמש באותו מאפיין בשני צירים. מאפיין גלוי רק אם הוא מופיע בטבלת ציר.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

string

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

object (CohortSpec)

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

boolean

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

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

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

boolean

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

object (Comparison)

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