Method: properties.reportTasks.query

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

בקשת HTTP

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

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

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

פרמטרים
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 שורות. לדוגמה, אם למשימת הדוח יש מגבלה של 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)

תיאור של עמודות המדדים. מספר הכותרות של המדדים והסדר שלהן תואם למדדים שמוצגים בשורות.
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