Method: properties.runRealtimeReport

یک گزارش سفارشی از داده‌های رویداد بی‌درنگ برای ملک شما برمی‌گرداند. رویدادها چند ثانیه پس از ارسال به گوگل آنالیتیکس، در گزارش‌های بی‌درنگ ظاهر می‌شوند. گزارش‌های بی‌درنگ، رویدادها و داده‌های استفاده را برای دوره‌های زمانی از لحظه حال تا 30 دقیقه پیش (تا 60 دقیقه برای ملک‌های گوگل آنالیتیکس 360) نشان می‌دهند.

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

درخواست HTTP

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

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

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

پارامترها
property

string

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

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

درخواست بدنه

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

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

object ( Dimension )

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

metrics[]

object ( Metric )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

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

limit

string ( int64 format)

تعداد ردیف‌هایی که باید برگردانده شوند. اگر مشخص نشود، ۱۰۰۰۰ ردیف برگردانده می‌شود. API حداکثر ۲۵۰۰۰۰ ردیف را در هر درخواست برمی‌گرداند، مهم نیست چند ردیف درخواست کنید. limit باید مثبت باشد.

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

metricAggregations[]

enum ( MetricAggregation )

تجمیع معیارها. مقادیر تجمیع‌شده‌ی معیارها در ردیف‌هایی نمایش داده می‌شوند که در آن‌ها مقادیر بُعد روی «RESERVED_(MetricAggregation)» تنظیم شده باشند.

orderBys[]

object ( OrderBy )

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

returnPropertyQuota

boolean

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

minuteRanges[]

object ( MinuteRange )

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

بدنه پاسخ

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

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

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

object ( DimensionHeader )

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

metricHeaders[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

totals[]

object ( Row )

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

maximums[]

object ( Row )

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

minimums[]

object ( Row )

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

rowCount

integer

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

propertyQuota

object ( PropertyQuota )

وضعیت سهمیه‌ی Realtime این ویژگی گوگل آنالیتیکس شامل این درخواست می‌شود.

kind

string

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

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

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

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

محدوده دقیقه

مجموعه‌ای پیوسته از دقیقه‌ها: startMinutesAgo ، startMinutesAgo + 1 ، ...، endMinutesAgo . درخواست‌ها تا محدوده ۲ دقیقه مجاز هستند.

نمایش JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
فیلدها
name

string

یک نام به این محدوده دقیقه اختصاص می‌دهد. بُعد dateRange در پاسخ گزارش به این نام مقداردهی می‌شود. اگر تنظیم شود، نمی‌تواند با date_range_ یا RESERVED_ شروع شود. اگر تنظیم نشود، محدوده‌های دقیقه با اندیس مبتنی بر صفر خود در درخواست نامگذاری می‌شوند: date_range_0 ، date_range_1 و غیره.

startMinutesAgo

integer

دقیقه شروع شامل برای پرس و جو به صورت تعدادی دقیقه قبل از اکنون. برای مثال، "startMinutesAgo": 29 مشخص می‌کند که گزارش باید شامل داده‌های رویداد از 29 دقیقه قبل و بعد از آن باشد. نمی‌تواند بعد از endMinutesAgo باشد.

اگر startMinutesAgo مشخص نشده باشد، به طور پیش‌فرض روی ۲۹ تنظیم شده است. ویژگی‌های استاندارد Analytics می‌توانند تا ۳۰ دقیقه آخر داده‌های رویداد را درخواست کنند ( startMinutesAgo <= 29 )، و ویژگی‌های ۳۶۰ Analytics می‌توانند تا ۶۰ دقیقه آخر داده‌های رویداد را درخواست کنند ( startMinutesAgo <= 59 ).

endMinutesAgo

integer

دقیقه پایان شامل برای پرس و جو به صورت تعدادی دقیقه قبل از اکنون است. نمی‌تواند قبل از startMinutesAgo باشد. برای مثال، "endMinutesAgo": 15 مشخص می‌کند که گزارش باید شامل داده‌های رویداد از قبل از 15 دقیقه پیش باشد.

اگر مشخص نشود، endMinutesAgo به طور پیش‌فرض روی ۰ تنظیم می‌شود. ویژگی‌های استاندارد Analytics می‌توانند هر دقیقه‌ای را در ۳۰ دقیقه آخر داده‌های رویداد درخواست کنند ( endMinutesAgo <= 29 )، و ویژگی‌های ۳۶۰ Analytics می‌توانند هر دقیقه‌ای را در ۶۰ دقیقه آخر داده‌های رویداد درخواست کنند ( endMinutesAgo <= 59 ).