Method: properties.runRealtimeReport

Mülkünüz için gerçek zamanlı etkinlik verilerinden oluşan özelleştirilmiş bir rapor döndürür. Etkinlikler, Google Analytics'e gönderildikten birkaç saniye sonra gerçek zamanlı raporlarda görünür. Gerçek zamanlı raporlar, geçerli andan 30 dakika öncesine kadar (Google Analytics 360 mülkleri için 60 dakikaya kadar) zaman aralıklarına ait etkinlik ve kullanım verilerini gösterir.

Gerçek zamanlı istekler oluşturma ve yanıtları anlamayla ilgili kılavuz için Gerçek Zamanlı Rapor Oluşturma başlıklı makaleyi inceleyin.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
property

string

Etkinlikleri izlenen bir Google Analytics GA4 mülkü tanımlayıcısı. Gövdede değil, URL yolunda belirtilir. Daha fazla bilgi için Mülk Kimliğinizi nerede bulabileceğinize bakın.

Örnek: mülkler/1234

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi
{
  "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)
    }
  ]
}
Alanlar
dimensions[]

object (Dimension)

İstenen ve görüntülenen boyutlar.

metrics[]

object (Metric)

İstenen ve görüntülenen metrikler.

dimensionFilter

object (FilterExpression)

Boyutların filtre ifadesi. Metrikler bu filtrede kullanılamaz.

metricFilter

object (FilterExpression)

Metriklerin filtre ifadesi. SQL'in yan tümcesine benzer şekilde toplama sonrası aşamasında uygulanır. Boyutlar bu filtrede kullanılamaz.

limit

string (int64 format)

Döndürülecek satır sayısı. Belirtilmemişse 10.000 satır döndürülür. API, kaç tane istediğinize bakılmaksızın istek başına maksimum 250.000 satır döndürür. limit pozitif olmalıdır.

Ayrıca, limit kadar çok boyut değeri yoksa API, istenen limit satırdan daha az satır döndürebilir. Örneğin, country boyutu için 300'den az olası değer vardır. Bu nedenle, yalnızca country ile ilgili rapor oluştururken limit değerini daha yüksek bir değere ayarlasanız bile 300'den fazla satır alamazsınız.

metricAggregations[]

enum (MetricAggregation)

Metriklerin toplamı. Birleştirilmiş metrik değerleri, boyutValues değerinin "RESERVED_(MetricAggregation)" olarak ayarlandığı satırlarda gösterilir.

orderBys[]

object (OrderBy)

Satırların yanıtta nasıl sıralanacağını belirtir.

returnPropertyQuota

boolean

Bu Analytics Mülkü'nün Gerçek Zamanlı kotasının mevcut durumunun döndürülüp döndürülmeyeceğini belirler. Kota, PropertyQuota içinde döndürülür.

minuteRanges[]

object (MinuteRange)

Okunacak etkinlik verilerinin dakika aralıkları. Belirtilmezse son 30 dakika için bir dakikalık aralık kullanılır. Birden fazla dakika aralığı istenirse her yanıt satırı sıfır tabanlı bir dakika aralığı dizini içerir. İki dakika aralığı çakışırsa çakışan dakikalara ait etkinlik verileri her iki dakika aralığının yanıt satırlarına eklenir.

Yanıt gövdesi

Bir isteğe karşılık gelen yanıt gerçek zamanlı rapor tablosu.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "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
}
Alanlar
dimensionHeaders[]

object (DimensionHeader)

Boyut sütunlarını açıklar. Boyut Üstbilgilerinin sayısı ve DIMENSIONHeaders sıralaması, satırlarda bulunan boyutlarla eşleşir.

metricHeaders[]

object (MetricHeader)

Metrik sütunlarını açıklar. MetricHeaders'ın sayısı ve MetricHeaders'ın sıralaması, satırlarda bulunan metriklerle eşleşir.

rows[]

object (Row)

Rapordaki boyut değeri kombinasyonları ve metrik değerleri satırları.

totals[]

object (Row)

İstenirse metriklerin toplam değerleri.

maximums[]

object (Row)

İstenirse metriklerin maksimum değerleri.

minimums[]

object (Row)

İstenirse minimum metrik değerleri.

rowCount

integer

Sorgu sonucundaki toplam satır sayısı. rowCount, yanıtta döndürülen satır sayısından ve limit istek parametresinden bağımsızdır. Örneğin bir sorgu 175 satır döndürüyorsa ve API isteğine limit/50 satır içeriyorsa yanıt, rowCount/175 satır ancak yalnızca 50 satır içerir.

propertyQuota

object (PropertyQuota)

Bu istek dahil olmak üzere bu Analytics mülkünün gerçek zamanlı kota durumu.

kind

string

Bu mesajın ne tür bir kaynak olduğunu tanımlar. Bu kind, her zaman "analyticsData#runRealtimeReport" sabit dizesidir. JSON'deki yanıt türlerini ayırt etmek için yararlıdır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

MinuteRange

Bitişik dakika grubu: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. İstekler 2 dakikalık aralıklara kadar izin verilir.

JSON gösterimi
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Alanlar
name

string

Bu dakika aralığına bir ad atar. Bir rapor yanıtında dateRange boyutu bu ada değerlendirilir. Ayarlanırsa date_range_ veya RESERVED_ ile başlayamaz. Ayarlanmazsa dakika aralıkları, istekteki sıfır tabanlı dizine göre adlandırılır: date_range_0, date_range_1 vb.

startMinutesAgo

integer

Şu andan itibaren dakika öncesi şeklinde sorgu için dahil başlangıç dakikası. Örneğin "startMinutesAgo": 29, raporun 29 dakika öncesi ve sonrası etkinlik verilerini içermesi gerektiğini belirtir. endMinutesAgo tarihinden sonra olamaz.

Belirtilmemişse varsayılan olarak startMinutesAgo değeri 29 olur. Standart Analytics mülkleri son 30 dakikaya kadar etkinlik verisi (startMinutesAgo <= 29) için istekte bulunabilir. 360 Analytics mülkleri ise son 60 dakikaya kadar olan etkinlik verilerini (startMinutesAgo <= 59) isteyebilir.

endMinutesAgo

integer

Şu andan önceki dakika sayısı şeklinde sorgu için dahil olan bitiş dakikası. startMinutesAgo tarihinden önce olamaz. Örneğin "endMinutesAgo": 15, raporun 15 dakika öncesine ait etkinlik verilerini içermesi gerektiğini belirtir.

Belirtilmemişse endMinutesAgo varsayılan olarak 0 değerine ayarlanır. Standart Analytics mülkleri, etkinlik verilerinin son 30 dakikası (endMinutesAgo <= 29) içindeki herhangi bir dakika için istekte bulunabilir. 360 Analytics mülkleri ise son 60 dakika içindeki etkinlik verilerinin (endMinutesAgo <= 59) herhangi bir dakikasını isteyebilir.