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)

اختیاری. تعداد ردیف‌های ردیف شروع در گزارش. ردیف اول به عنوان ردیف ۰ شمارش می‌شود.

هنگام صفحه‌بندی، درخواست اول آفست را مشخص نمی‌کند؛ یا به طور معادل، آفست را روی ۰ تنظیم می‌کند؛ درخواست اول limit اول ردیف‌ها را برمی‌گرداند. درخواست دوم آفست را روی limit درخواست اول تنظیم می‌کند؛ درخواست دوم limit دوم ردیف‌ها را برمی‌گرداند.

برای کسب اطلاعات بیشتر در مورد این پارامتر صفحه‌بندی، به صفحه‌بندی مراجعه کنید.

limit

string ( int64 format)

اختیاری. تعداد ردیف‌هایی که از گزارش برگردانده می‌شوند. اگر مشخص نشود، ۱۰۰۰۰ ردیف برگردانده می‌شود. API حداکثر ۲۵۰۰۰۰ ردیف را در هر درخواست برمی‌گرداند، مهم نیست چند ردیف درخواست کنید. limit باید مثبت باشد.

اگر تعداد مقادیر بُعد به اندازه‌ی limit نباشد، API می‌تواند تعداد ردیف‌های کمتری نسبت به limit درخواستی برگرداند. تعداد ردیف‌های موجود برای یک QueryReportTaskRequest توسط محدودیت ReportTask مرتبط، محدودتر نیز می‌شود. یک پرس‌وجو می‌تواند حداکثر ردیف‌های ReportTask.limit را بازیابی کند. برای مثال، اگر ReportTask محدودیت ۱۰۰۰ داشته باشد، یک درخواست reportTasks.query با offset=900 و limit=500 حداکثر ۱۰۰ ردیف را برمی‌گرداند.

برای کسب اطلاعات بیشتر در مورد این پارامتر صفحه‌بندی، به صفحه‌بندی مراجعه کنید.

بدنه پاسخ

محتوای گزارش مربوط به یک وظیفه گزارش.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش 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 و ترتیب DimensionHeaders با ابعاد موجود در ردیف‌ها مطابقت دارد.

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