Method: properties.batchRunReports

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

درخواست HTTP

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

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

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

پارامترها
property

string

شناسه دارایی Google Analytics GA4 که رویدادهای آن ردیابی می شوند. در مسیر URL و نه بدنه مشخص شده است. برای کسب اطلاعات بیشتر، ببینید شناسه ملک خود را از کجا پیدا کنید . این ویژگی باید برای دسته مشخص شود. ویژگی موجود در RunReportRequest ممکن است نامشخص یا مطابق با این ویژگی باشد.

مثال: خواص/1234

درخواست بدن

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

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

object ( RunReportRequest )

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

بدن پاسخگو

پاسخ دسته ای حاوی گزارش های متعدد.

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

نمایندگی 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

RunReportRequest

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

نمایندگی 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

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

مثال: خواص/1234

dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

dateRanges[]

object ( DateRange )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

offset

string ( int64 format)

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

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

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

limit

string ( int64 format)

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

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

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

metricAggregations[]

enum ( MetricAggregation )

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

orderBys[]

object ( OrderBy )

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

currencyCode

string

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

cohortSpec

object ( CohortSpec )

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

keepEmptyRows

boolean

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

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

به عنوان مثال، اگر یک ویژگی هرگز رویداد purchase ثبت نکند، در این صورت درخواستی برای بعد eventName و متریک eventCount دارای سطر eventName: "purchase" و eventCount: 0 نخواهد بود.

returnPropertyQuota

boolean

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

comparisons[]

object ( Comparison )

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