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)

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

object (FilterExpression)

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

object (FilterExpression)

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

object (OrderBy)

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

string

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

object (CohortSpec)

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

boolean

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

boolean

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