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 עם offset=900 ו-limit=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, קטגוריות מסוימות של שילובי מאפיינים מועברות ל-'(other)'. השורה הראשונה. מצב כזה יכול לקרות בדוחות בעלי עוצמה גבוהה.

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

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

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

object (SchemaRestrictionResponse)

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

string

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

קודי מטבע הם קידוד מחרוזות של סוגי מטבעות לפי תקן 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" או 'אסיה/טוקיו'.
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 מסוימים.

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