Method: properties.runPivotReport

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

درخواست HTTP

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

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

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

پارامترها
property

string

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

مثال: خواص/1234

درخواست بدن

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

نمایندگی JSON 
{
  "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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
فیلدها
dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

date Ranges[]

object ( DateRange )

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

pivots[]

object ( Pivot )

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

dimension Filter

object ( FilterExpression )

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

metric Filter

object ( FilterExpression )

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

currency Code

string

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

cohort Spec

object ( CohortSpec )

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

keep Empty Rows

boolean

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

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

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

return Property Quota

boolean

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

comparisons[]

object ( Comparison )

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

بدن پاسخگو

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

محدوده مجوز

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

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