Method: batchRunReports

چندین گزارش را در یک دسته برمی گرداند. همه گزارش ها باید برای یک نهاد باشد.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha:batchRunReports

URL از دستور GRPC Transcoding استفاده می کند.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "entity": {
    object (Entity)
  },
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
زمینه های
entity

object ( Entity )

ملکی که وقایع آن پیگیری می شود. این موجودیت باید برای دسته مشخص شود. موجودیت موجود در RunReportRequest ممکن است نامشخص یا مطابق با این موجودیت باشد.

requests[]

object ( RunReportRequest )

درخواست های فردی هر درخواست یک پاسخ گزارش جداگانه دارد. هر درخواست دسته ای حداکثر تا 5 درخواست مجاز است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

پاسخ دسته ای حاوی چندین گزارش.

نمایندگی JSON
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ]
}
زمینه های
reports[]

object ( RunReportResponse )

پاسخ های فردی هر پاسخ یک درخواست گزارش جداگانه دارد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

RunReportRequest

درخواست برای تهیه گزارش

نمایندگی JSON
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
زمینه های
entity

object ( Entity )

ملکی که وقایع آن پیگیری می شود. در یک درخواست دسته ای، این موجودیت باید یا نامشخص باشد یا با موجودیت در سطح دسته ای سازگار باشد.

dimensions[]

object ( Dimension )

ابعاد درخواستی و نمایش داده شده

metrics[]

object ( Metric )

معیارهای درخواست شده و نمایش داده شده

dateRanges[]

object ( DateRange )

محدوده تاریخ داده برای خواندن. اگر چندین محدوده تاریخ درخواست شود، هر ردیف پاسخ حاوی یک شاخص محدوده تاریخ مبتنی بر صفر خواهد بود. اگر دو محدوده تاریخ همپوشانی داشته باشند، داده‌های رویداد برای روزهای همپوشانی در ردیف‌های پاسخ برای هر دو محدوده تاریخ گنجانده می‌شود. در یک درخواست گروهی، این dateRanges باید نامشخص باشد.

offset

string ( int64 format)

تعداد ردیف ردیف شروع. ردیف اول به عنوان ردیف 0 محاسبه می شود.

limit

string ( int64 format)

تعداد ردیف هایی که باید برگردانده شوند. اگر پارامتر limit مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 100000 سطر در هر درخواست را برمی گرداند، مهم نیست که چقدر درخواست کنید.

metricAggregations[]

enum ( MetricAggregation )

تجمیع معیارها مقادیر متریک انبوه در ردیف‌هایی نشان داده می‌شوند که در آن dimensionValues ​​روی "RESERVED_(MetricAggregation)" تنظیم شده است.

dimensionFilter

object ( FilterExpression )

بند فیلتر ابعاد. برای استفاده در این فیلتر باید ابعاد درخواست شود. معیارها را نمی توان در این فیلتر استفاده کرد.

metricFilter

object ( FilterExpression )

بند فیلتر معیارها. در مرحله پس از تجمع، مشابه SQL دارای بند اعمال می شود. برای استفاده در این فیلتر باید معیارها را درخواست کرد. در این فیلتر نمی توان از ابعاد استفاده کرد.

orderBys[]

object ( OrderBy )

نحوه ترتیب ردیف ها در پاسخ را مشخص می کند.

currencyCode

string

یک کد ارز در قالب ISO4217، مانند "AED"، "USD"، "JPY". اگر فیلد خالی باشد، گزارش از واحد پول پیش‌فرض موجودیت استفاده می‌کند.

cohortSpec

object ( CohortSpec )

گروه کوهورت مرتبط با این درخواست. اگر یک گروه کوهورت در درخواست وجود دارد، بعد "همگروهی" باید وجود داشته باشد.

keepEmptyRows

boolean

اگر نادرست یا نامشخص باشد، هر ردیف با تمام معیارهای برابر با 0 برگردانده نخواهد شد. اگر درست باشد، اگر این ردیف‌ها به‌طور جداگانه توسط فیلتر حذف نشوند، برگردانده می‌شوند.

returnPropertyQuota

boolean

وضعیت فعلی سهمیه این Analytics Property را تغییر می‌دهد یا خیر. سهمیه در PropertyQuota برگردانده می شود.