Method: properties.runReport

Google Analytics etkinlik verilerinizin özelleştirilmiş bir raporunu döndürür. Raporlar, Google Analytics izleme kodu tarafından toplanan verilerden elde edilen istatistikleri içerir. API'den döndürülen veriler, istenen boyutların ve metriklerin sütunlarını içeren bir tablodur. Metrikler, mülkünüzdeki kullanıcı etkinliklerinin (etkin kullanıcılar veya etkinlik sayısı gibi) ayrı ayrı ölçümüdür. Boyutlar, metrikleri ülke veya etkinlik adı gibi bazı yaygın ölçütlere göre ayırır.

İstek oluşturma ve yanıtları anlamayla ilgili kılavuz için Rapor Oluşturma başlıklı makaleyi inceleyin.

HTTP isteği

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

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övde metninde değil, URL yolunda belirtilir. Daha fazla bilgi edinmek için Mülk Kimliğinizi nerede bulacağınızı öğrenin. Bir toplu işlem isteğinde bu özellik belirtilmemiş veya toplu düzey özelliğiyle tutarlı olmalıdır.

Örnek: mülkler/1234

İstek içeriği

İstek gövdesi aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Alanlar
dimensions[]

object (Dimension)

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

metrics[]

object (Metric)

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

dateRanges[]

object (DateRange)

Okunacak veri tarih aralıkları. Birden fazla tarih aralığı istenirse her yanıt satırında sıfır tabanlı bir tarih aralığı dizini bulunur. İki tarih aralığı çakışırsa, çakışan günlere ait etkinlik verileri her iki tarih aralığının yanıt satırlarına eklenir. Bir grup isteğinde bu dateRanges belirtilmemelidir.

dimensionFilter

object (FilterExpression)

Boyut filtreleri, raporda yalnızca belirli boyut değerlerini istemenize olanak tanır. Daha fazla bilgi edinmek için Boyut Filtrelerinin Temelleri bölümünü inceleyin. Metrikler bu filtrede kullanılamaz.

metricFilter

object (FilterExpression)

Metriklerin filtre koşulu. SQL'in sahip olduğu içeriğe benzer şekilde, rapor satırları toplandıktan sonra uygulanır. Boyutlar bu filtrede kullanılamaz.

offset

string (int64 format)

Başlangıç satırının satır sayısı. İlk satır 0. satır olarak sayılır.

Sayfalara ayırma sırasında ilk istek, ofset belirtmiyor veya eşdeğer şekilde ofseti 0 olarak ayarlıyor; ilk istek satırların ilk limit tanesini döndürüyor. İkinci istek, ilk isteğin limit kadarı için ofset belirler. İkinci istek, ikinci satır limit değerini döndürür.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfalara ayırma bölümünü inceleyin.

limit

string (int64 format)

Döndürülecek satırların sayısı. Belirtilmemesi halinde 10.000 satır döndürülür. Kaç API isterseniz isteyin, API istek başına maksimum 250.000 satır döndürür. limit pozitif olmalıdır.

Ayrıca, limit kadar fazla boyut değeri yoksa API, istenen limit değerinden 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.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfalara ayırma bölümünü inceleyin.

metricAggregations[]

enum (MetricAggregation)

Metriklerin toplanması. Toplu metrik değerleri,SizeValues değerinin "RESERVED_(MetricAggregation)" olarak ayarlandığı satırlarda gösterilir.

orderBys[]

object (OrderBy)

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

currencyCode

string

"AED", "USD", "JPY" gibi ISO4217 biçiminde bir para birimi kodu. Alan boşsa rapor, mülkün varsayılan para birimini kullanır.

cohortSpec

object (CohortSpec)

Bu istekle ilişkili grup grubu. İstekte bir grup grubu varsa "kohort" boyutu bulunmalıdır.

keepEmptyRows

boolean

Yanlış ise veya belirtilmezse tüm metrikleri 0 olan her satır döndürülmez. True (Doğru) ise, bir filtre tarafından ayrı olarak kaldırılmazsa bu satırlar döndürülür.

Bu keepEmptyRows ayarından bağımsız olarak bir raporda yalnızca Google Analytics (GA4) mülkü tarafından kaydedilen veriler görüntülenebilir.

Örneğin, bir mülk hiçbir zaman purchase etkinliğini günlüğe kaydedmiyorsa eventName boyutu ve eventCount metriği için yapılan sorgu, satır eventName: "purchase" ve eventCount: 0 değerini içermez.

returnPropertyQuota

boolean

Bu Analytics Mülkünün kotasının geçerli durumunu döndürüp döndürmeyeceğini açar. Kota PropertyQuota içinde döndürülür.

Yanıt gövdesi

Başarılıysa yanıt metni, RunReportResponse öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

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

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