Method: properties.runRealtimeReport

Mülkünüze ait gerçek zamanlı etkinlik verilerinin özelleştirilmiş bir raporunu döndürür. Etkinlikler, Google Analytics'e gönderildikten birkaç saniye sonra anlık raporlarda görünür. Anlık raporlar, mevcut andan 30 dakika öncesine kadar olan (Google Analytics 360 mülkleri için 60 dakikaya kadar) dönemlere ait etkinlikleri ve kullanım verilerini gösterir.

Gerçek zamanlı istek oluşturma ve yanıtları anlama rehberi 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 mülkü kimliği. 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 metni aşağıdaki yapıyla birlikte verileri 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 having-clause'a benzer şekilde, toplama sonrası aşamada 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 isterseniz isteyin istek başına en fazla 250.000 satır döndürür. limit pozitif olmalıdır.

limit kadar boyut değeri yoksa API, istenen limit değerinden daha az satır da döndürebilir. Örneğin, country boyutu için 300'den az olası değer vardır. Bu nedenle, yalnızca country hakkında 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 toplanması. Toplu metrik değerleri, dimensionValues'ın "RESERVED_(MetricAggregation)" olarak ayarlandığı satırlarda gösterilir.

orderBys[]

object (OrderBy)

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

returnPropertyQuota

boolean

Bu Google 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)

Okunan 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 dahil edilir.

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. DimensionHeaders sayısı ve DimensionHeaders sıralaması, satırlarda bulunan boyutlarla eşleşiyor.

metricHeaders[]

object (MetricHeader)

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

rows[]

object (Row)

Rapordaki boyut değeri kombinasyonlarının ve metrik değerlerinin bulunduğu satırlar.

totals[]

object (Row)

İstenirse metriklerin toplam değerleri.

maximums[]

object (Row)

İstenirse metriklerin maksimum değerleri.

minimums[]

object (Row)

İstenirse metriklerin minimum 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ğinde 50 tane limit içeriyorsa yanıtta 175 tane rowCount bulunur ancak yalnızca 50 satır vardır.

propertyQuota

object (PropertyQuota)

Bu Google Analytics mülkünün, bu isteği içeren anlık kota durumu.

kind

string

Bu mesajın ne tür bir kaynak olduğunu tanımlar. Bu kind her zaman sabit "analyticsData#runRealtimeReport" dizesidir. JSON'daki yanıt türlerini ayırt etmek için kullanışlı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

Art arda gelen dakikalar: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. 2 dakikalık aralıklarla istek gönderilebilir.

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

string

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

startMinutesAgo

integer

Sorgunun başlangıç dakikası (şimdiki zamandan itibaren dakika sayısı olarak). Örneğin, "startMinutesAgo": 29, raporun 29 dakika öncesine ve sonrasına ait etkinlik verilerini içermesi gerektiğini belirtir. endMinutesAgo tarihinden sonra olamaz.

Belirtilmemişse startMinutesAgo varsayılan olarak 29 olur. Standart Analytics mülkleri en fazla son 30 dakikaya ait etkinlik verileri (startMinutesAgo <= 29) isteyebilir. 360 Analytics mülkleri ise en fazla son 60 dakikaya ait etkinlik verileri (startMinutesAgo <= 59) isteyebilir.

endMinutesAgo

integer

Sorgunun bitiş dakikası (şimdiki zamandan itibaren dakika sayısı olarak). 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ındaki herhangi bir dakikayı (endMinutesAgo <= 29) ve 360 Analytics mülkleri, etkinlik verilerinin son 60 dakikasındaki herhangi bir dakikayı (endMinutesAgo <= 59) isteyebilir.