Method: batchRunPivotReports

מחזירה מספר דוחות צירים באצווה. כל הדוחות חייבים להתייחס לאותה יישות.

בקשת HTTP

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

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

גוף הבקשה

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

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

object (Entity)

נכס שיש מעקב אחרי האירועים שלו. יש לציין את הישות הזו עבור האצווה. ייתכן שהישות בתוך RunPivotReportRequest לא תואמת או לא תואמת לישות הזו.
requests[]

object (RunPivotReportRequest)

בקשות נפרדות. לכל בקשה יש תגובה נפרדת לדוח צירים. כל בקשה באצווה יכולה לכלול עד 5 בקשות.

גוף התשובה

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

תגובה באצווה שמכילה מספר דוחות צירים.

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

object (RunPivotReportResponse)

תשובות אישיות. לכל תגובה יש בקשה נפרדת לדוח צירים.

היקפי ההרשאות

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

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

RunPivotReportRequest

הבקשה ליצירת דוח ציר.

ייצוג 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)

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

object (Metric)

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

object (FilterExpression)

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

object (FilterExpression)

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

object (Pivot)

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

object (DateRange)

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

string

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

object (CohortSpec)

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

boolean

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

boolean

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