Method: properties.runReport

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

למדריך ליצירת בקשות כדי להבין את התשובות, ראו יצירת דוח.

בקשת HTTP

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

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

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

פרמטרים
property

string

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

דוגמה: properties/1234

גוף הבקשה

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

ייצוג JSON 
{
  "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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
שדות
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. לדוגמה, למאפיין country יש פחות מ-300 ערכים אפשריים, ולכן כשמדווחים על country בלבד, אי אפשר לקבל יותר מ-300 שורות, גם אם הגדרתם ל-limit ערך גבוה יותר.

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

enum (MetricAggregation)

צבירת מדדים. ערכי המדדים המצטברים יוצגו בשורות שבהן המאפיין assetValues מוגדר כ-"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 לא יופיע שם האירוע בשורה: "purchase" ו-eventCount: 0.
returnPropertyQuota

boolean

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

object (Comparison)

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

גוף התשובה

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

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

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

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