Method: properties.runRealtimeReport

Google Analytics Realtime API یک گزارش سفارشی از داده های رویداد بیدرنگ را برای دارایی شما برمی گرداند. این گزارش ها رویدادها و استفاده از 30 دقیقه گذشته را نشان می دهد.

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport

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

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

مولفه های
property

string

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

مثال: خواص/1234

درخواست بدن

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

نمایندگی JSON
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
زمینه های
dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

limit

string ( int64 format)

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

metricAggregations[]

enum ( MetricAggregation )

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

orderBys[]

object ( OrderBy )

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

returnPropertyQuota

boolean

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

بدن پاسخگو

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

جدول گزارش بیدرنگ پاسخ مربوط به یک درخواست.

نمایندگی JSON
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
زمینه های
dimensionHeaders[]

object ( DimensionHeader )

ستون های ابعاد را توصیف می کند. تعداد DimensionHeader و ترتیب DimensionHeaders با ابعاد موجود در ردیف ها مطابقت دارد.

metricHeaders[]

object ( MetricHeader )

ستون های متریک را توصیف می کند. تعداد MetricHeader و ترتیب MetricHeaders با معیارهای موجود در ردیف ها مطابقت دارد.

rows[]

object ( Row )

ردیف هایی از ترکیبات ارزش ابعاد و مقادیر متریک در گزارش.

totals[]

object ( Row )

در صورت درخواست، مجموع مقادیر معیارها.

maximums[]

object ( Row )

در صورت درخواست، حداکثر مقادیر معیارها.

minimums[]

object ( Row )

در صورت درخواست، حداقل مقادیر معیارها.

rowCount

integer

تعداد کل ردیف ها در نتیجه پرس و جو، صرف نظر از تعداد ردیف های برگشت داده شده در پاسخ. به عنوان مثال اگر یک پرس و جو 175 ردیف را برمی گرداند و شامل محدودیت = 50 در درخواست API باشد، پاسخ شامل rowCount = 175 اما فقط 50 ردیف خواهد بود.

propertyQuota

object ( PropertyQuota )

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

محدوده مجوز

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

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