Method: properties.batchRunPivotReports

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

درخواست HTTP

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

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

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

مولفه های
property

string

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

مثال: خواص/1234

درخواست بدن

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

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

object ( RunPivotReportRequest )

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

بدن پاسخگو

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

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

نمایندگی JSON
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
زمینه های
pivotReports[]

object ( RunPivotReportResponse )

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

kind

string

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

محدوده مجوز

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

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

RunPivotReportRequest

درخواست ایجاد یک گزارش محوری.

نمایندگی JSON
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
زمینه های
property

string

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

مثال: خواص/1234

dimensions[]

object ( Dimension )

ابعاد درخواستی همه ابعاد تعریف شده باید توسط یکی از موارد زیر استفاده شوند: dimensionExpression، dimensionFilter، pivots، orderBys.

metrics[]

object ( Metric )

معیارهای درخواستی، حداقل یک معیار باید مشخص شود. همه معیارهای تعریف شده باید توسط یکی از موارد زیر استفاده شوند: metric_expression، metricFilter، orderBys.

dateRanges[]

object ( DateRange )

محدوده تاریخ برای بازیابی اطلاعات رویداد برای گزارش. اگر چندین محدوده تاریخ مشخص شده باشد، داده های رویداد از هر محدوده تاریخ در گزارش استفاده می شود. یک بعد خاص با نام فیلد "DateRange" را می توان در نام فیلدهای Pivot گنجاند. اگر شامل شود، گزارش بین محدوده تاریخ مقایسه می شود. در یک درخواست گروهی، این dateRanges باید نامشخص باشد.

pivots[]

object ( Pivot )

قالب بصری ابعاد گزارش را در ستون یا ردیف توضیح می دهد. اتحاد فیلدNames (نام ابعاد) در همه محورها باید زیرمجموعه ای از نام ابعاد تعریف شده در Dimensions باشد. هیچ دو محوری نمی تواند یک بعد را به اشتراک بگذارد. یک بعد فقط زمانی قابل مشاهده است که در یک محور ظاهر شود.

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

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 برگردانده می شود.