Method: properties.batchRunReports

چندین گزارش را به صورت دسته‌ای برمی‌گرداند. همه گزارش‌ها باید برای یک ویژگی گوگل آنالیتیکس باشند.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
property

string

یک شناسه ویژگی گوگل آنالیتیکس که رویدادهای آن ردیابی می‌شوند. در مسیر URL مشخص شده است و نه در بدنه. برای کسب اطلاعات بیشتر، به محل یافتن شناسه ویژگی خود مراجعه کنید. این ویژگی باید برای دسته مشخص شود. ویژگی درون RunReportRequest ممکن است نامشخص یا با این ویژگی سازگار باشد.

مثال: ویژگی‌ها/۱۲۳۴

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
فیلدها
requests[]

object ( RunReportRequest )

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

بدنه پاسخ

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

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

نمایش JSON 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
فیلدها
reports[]

object ( RunReportResponse )

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

kind

string

نوع منبع این پیام را مشخص می‌کند. این kind همیشه رشته ثابت "analyticsData#batchRunReports" است. برای تمایز بین انواع پاسخ در JSON مفید است.

دامنه‌های مجوز

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

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

درخواست گزارش اجرا

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

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

string

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

مثال: ویژگی‌ها/۱۲۳۴

dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

dateRanges[]

object ( DateRange )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

offset

string ( int64 format)

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

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

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

limit

string ( int64 format)

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

اگر تعداد مقادیر بُعد به اندازه‌ی limit نباشد، API می‌تواند تعداد ردیف‌های کمتری نسبت به limit درخواستی برگرداند. برای مثال، کمتر از ۳۰۰ مقدار ممکن برای بُعد country وجود دارد، بنابراین هنگام گزارش‌گیری فقط بر اساس country ، نمی‌توانید بیش از ۳۰۰ ردیف دریافت کنید، حتی اگر limit روی مقدار بالاتری تنظیم کنید.

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

metricAggregations[]

enum ( MetricAggregation )

تجمیع معیارها. مقادیر تجمیع‌شده‌ی معیارها در ردیف‌هایی نشان داده می‌شوند که در آن‌ها مقادیر بُعد روی "RESERVED_(MetricAggregation)" تنظیم شده‌اند. تجمیع‌ها شامل مقایسه‌ها و چندین محدوده‌ی زمانی بر اساس محدوده‌های زمانی تجمیع می‌شوند.

orderBys[]

object ( OrderBy )

نحوه‌ی مرتب‌سازی ردیف‌ها در پاسخ را مشخص می‌کند. درخواست‌هایی که شامل مقایسه‌ها و چندین محدوده‌ی زمانی هستند، ترتیب مقایسه‌ها را اعمال خواهند کرد.

currencyCode

string

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

cohortSpec

object ( CohortSpec )

گروه هم‌گروهی مرتبط با این درخواست. اگر در درخواست، گروه هم‌گروهی وجود دارد، بُعد «هم‌گروهی» باید موجود باشد.

keepEmptyRows

boolean

اگر false یا نامشخص باشد، هر ردیفی که تمام معیارهای آن برابر با ۰ باشد، بازگردانده نمی‌شود. اگر true باشد، این ردیف‌ها در صورتی که جداگانه توسط فیلتر حذف نشده باشند، بازگردانده می‌شوند.

صرف نظر از این تنظیم keepEmptyRows ، فقط داده‌های ثبت‌شده توسط ویژگی Google Analytics می‌توانند در یک گزارش نمایش داده شوند.

برای مثال، اگر یک ویژگی هرگز رویداد purchase را ثبت نکند، آنگاه یک پرس‌وجو برای بُعد eventName و معیار eventCount ، ردیف eventName: "purchase" و eventCount: 0 نخواهد داشت.

returnPropertyQuota

boolean

وضعیت فعلی سهمیه این ویژگی گوگل آنالیتیکس را برمی‌گرداند یا خیر. سهمیه در PropertyQuota برگردانده می‌شود.

comparisons[]

object ( Comparison )

اختیاری. پیکربندی مقایسه‌های درخواستی و نمایش داده شده. درخواست فقط به یک فیلد مقایسه نیاز دارد تا بتواند یک ستون مقایسه در پاسخ دریافت کند.