Method: properties.reportTasks.query

אחזור התוכן של משימת דיווח. אחרי שליחת הבקשה לreportTasks.create, תהיה לך אפשרות לאחזר את תוכן הדוח ברגע שהדוח יהיה פעיל. השיטה הזו תחזיר שגיאה אם המצב של משימת הדיווח הוא לא ACTIVE. תגובת שאילתה תחזיר את ערכי השורות והעמודות בטבלה של הדוח.

בקשת HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

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

פרמטרים
name

string

חובה. השם של מקור הדוח. פורמט: properties/{property}/reportTasks/{report}

גוף הבקשה

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

ייצוג JSON 
{
  "offset": string,
  "limit": string
}
שדות
offset

string (int64 format)

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

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

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

string (int64 format)

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

כמו כן, ה-API יכול להחזיר פחות שורות מהשדה limit המבוקש, אם אין מספיק ערכי מאפיינים כמו המאפיין limit. מספר השורות הזמינות ל-QueryReportTaskRequest מוגבל עוד יותר על ידי המגבלה של משימות ה-ReportTask המשויכת. שאילתה יכולה לאחזר לכל היותר שורות ReportTask.limit. לדוגמה, אם ב-ReportTask יש מגבלה של 1,000, בקשת reportTasks.query עם היסט=900 ומגבלה=500 תחזיר לכל היותר 100 שורות.

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

גוף התשובה

התוכן של הדוח שקשור למשימת דיווח.

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

ייצוג JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
שדות
dimensionHeaders[]

object (DimensionHeader)

מתאר את עמודות המימדים. מספר הכותרות של מימדים והסדר של 'כותרות המאפיינים' תואם למאפיינים שמוצגים בשורות.
metricHeaders[]

object (MetricHeader)

מתאר עמודות מטריות. מספר הכותרות של MetricHeaders והסדר של MetricHeaders תואם למדדים שנמצאים בשורות.
rows[]

object (Row)

שורות של שילובי ערכי מאפיינים וערכי מדדים בדוח.
totals[]

object (Row)

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

object (Row)

אם מתבקשים, הערכים המקסימליים של המדדים.
minimums[]

object (Row)

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

integer

המספר הכולל של השורות בתוצאת השאילתה.
metadata

object (ResponseMetaData)

מטא-נתונים של הדוח.

היקפי הרשאות

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

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

ResponseMetaData

המטא-נתונים של התשובה שמכילים מידע נוסף על תוכן הדוח.

ייצוג JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
שדות
dataLossFromOtherRow

boolean

אם הערך הוא True, המשמעות היא שחלק מהקטגוריות של שילובי המאפיינים מצורפות לשורה '(אחר)'. מצב כזה יכול לקרות בדוחות עם עוצמה (cardinality) גבוהה.

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

לדוגמה, יכול להיות שהשורה (אחר) תוסר מהדוח כי הבקשה מכילה מסנן בפרמטר sessionSource = google. הפרמטר הזה עדיין יאוכלס אם היה אובדן נתונים משורה אחרת בנתונים הנצברים שמשמשים ליצירת הדוח הזה.

מידע נוסף זמין במאמר מידע על השורה (אחר) ועל דגימת נתונים.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

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

קודי מטבע הם קידודי מחרוזות של סוגי מטבעות בהתאם לתקן ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217). לדוגמה: USD, EUR, JPY. מידע נוסף זמין בכתובת https://support.google.com/analytics/answer/9796179.
timeZone

string

אזור הזמן הנוכחי של הנכס. המערכת מיועדת לשימוש כדי לפרש מאפיינים מבוססי-זמן, כמו hour ו-minute. בפורמט של מחרוזות ממסד הנתונים של אזור הזמן IANA (https://www.iana.org/time-zones). לדוגמה, "America/New_York" או "Asia/Tokyo".
emptyReason

string

אם לא מציינים סיבה, הדוח יהיה ריק מהסיבה הזו.
subjectToThresholding

boolean

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

SchemaRestrictionResponse

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

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

object (ActiveMetricRestriction)

כל ההגבלות שנאכפות באופן פעיל ביצירת הדוח. למשל, ב-purchaseRevenue תמיד יופיע סוג ההגבלה REVENUE_DATA. עם זאת, ההגבלה הפעילה הזו על התגובה תאוכלס רק אם התפקיד המותאם אישית של המשתמש לא מאפשר גישה אל REVENUE_DATA.

ActiveMetricRestriction

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

ייצוג JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
שדות
restrictedMetricTypes[]

enum (RestrictedMetricType)

הסיבה להגבלה של המדד הזה.
metricName

string

שם המדד המוגבל.

RestrictedMetricType

קטגוריות של נתונים שייתכן שתוגבל להצגה בנכסי GA4 מסוימים.

טיפוסים בני מנייה (enums)
RESTRICTED_METRIC_TYPE_UNSPECIFIED הסוג לא צוין.
COST_DATA מדדי עלות כמו adCost.
REVENUE_DATA מדדי הכנסה כמו purchaseRevenue.