Method: properties.reportTasks.query

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
name

string

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

גוף הבקשה

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

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

string (int64 format)

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

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

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

string (int64 format)

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

ה-API יכול גם להחזיר פחות שורות מאשר limit המבוקש, אם יש פחות ערכים של מאפיינים מאשר limit. מספר השורות שזמינות ל-QueryReportTaskRequest מוגבל גם על ידי המגבלה של ReportTask המשויך. שאילתות יכולות לאחזר עד ReportTask.limit שורות. לדוגמה, אם למשימות הדוחות יש מגבלה של 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)

תיאור של עמודות מאפיינים. מספר ה-DimensionHeaders והסדר שלהם תואמים למאפיינים שקיימים בשורות.
metricHeaders[]

object (MetricHeader)

תיאור של עמודות מדדים. מספר הכותרות של המדדים והסדר שלהן תואמים למדדים שמופיעים בשורות.
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,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
שדות
dataLossFromOtherRow

boolean

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

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

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

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

object (SamplingMetadata)

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

עם זאת, אם לא מתבצעת דגימה של התוצאות, השדה הזה לא יוגדר.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

קוד המטבע שמוצג בדוח הזה. מיועד לשימוש בפורמט של מדדי מטבע כמו purchaseRevenue לצורך תצוגה חזותית. אם הפרמטר currencyCode צוין בבקשה, פרמטר התגובה הזה יחזור על הפרמטר של הבקשה. אחרת, פרמטר התגובה הזה הוא 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

קטגוריות של נתונים שיכול להיות שאתם לא יכולים לראות בנכסי Google Analytics מסוימים.

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