Method: batchRunReports

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

בקשת HTTP

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

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

גוף הבקשה

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

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

object (Entity)

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

object (RunReportRequest)

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

גוף התשובה

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

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

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

object (RunReportResponse)

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

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

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

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

RunReportRequest

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

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

object (Entity)

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

object (Dimension)

המאפיינים המבוקשים והמוצגים.
metrics[]

object (Metric)

המדדים המבוקשים והוצגו.
dateRanges[]

object (DateRange)

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

string (int64 format)

מספר השורות בשורת ההתחלה. השורה הראשונה נספרת כשורה 0.
limit

string (int64 format)

מספר השורות שיש להחזיר. אם לא צוין הפרמטר limit, מוחזרות 10,000 שורות. ה-API מחזיר עד 100,000 שורות לבקשה, ללא קשר לכמות שתבקש.
metricAggregations[]

enum (MetricAggregation)

צבירת מדדים. ערכי המדדים הנצברים יוצגו בשורות שבהן ערכי ה-dimensionValue מוגדרים כ-"RESERVED_(MetricAggregation)".
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

object (OrderBy)

מציין את סדר השורות בתשובה.
currencyCode

string

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

object (CohortSpec)

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

boolean

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

boolean

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