Method: properties.runPivotReport

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

درخواست HTTP

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

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

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

پارامترها
property

string

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

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

درخواست بدنه

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

نمایش 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.

dateRanges[]

object ( DateRange )

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

pivots[]

object ( Pivot )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

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 )

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

بدنه پاسخ

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

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

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

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