Method: properties.batchRunReports

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

בקשת HTTP

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

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

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

פרמטרים
property

string

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

דוגמה: properties/1234

גוף הבקשה

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

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

object (RunReportRequest)

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

גוף התשובה

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

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

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

object (RunReportResponse)

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

string

מזהה את סוג המשאב ההודעה הזו. kind הוא תמיד המחרוזת הקבועה "analyticsData#batchRunReports". שימושי להבחנה בין סוגי תגובות ב-JSON.

היקפי הרשאות

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

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

RunReportRequest

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

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

string

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

דוגמה: properties/1234
dimensions[]

object (Dimension)

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

object (Metric)

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

object (DateRange)

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

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

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

במהלך החלוקה לדפים, הבקשה הראשונה לא מציינת היסט. או לחלופין, מגדירה היסט ל-0. הבקשה הראשונה מחזירה את limit השורות הראשונות. הבקשה השנייה מגדירה קיזוז ל-limit של הבקשה הראשונה. הבקשה השנייה מחזירה את limit השורות השניות.

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.
limit

string (int64 format)

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

כמו כן, ה-API יכול להחזיר פחות שורות מהשדה limit המבוקש, אם אין מספיק ערכי מאפיינים כמו המאפיין limit. לדוגמה, יש פחות מ-300 ערכים אפשריים למאפיין 'country', כך שכשמדווחים רק על country, אי אפשר לקבל יותר מ-300 שורות, גם אם מגדירים ל-limit ערך גבוה יותר.

מידע נוסף על פרמטר העימוד הזה זמין במאמר עימוד.
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

string

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

object (CohortSpec)

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

boolean

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

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

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

boolean

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