Method: properties.runReport

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

İstek oluşturma ve yanıtları anlamayla ilgili kılavuz için Rapor Oluşturma konusuna bakın.

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övdede değil, URL yolunda belirtilir. Daha fazla bilgi için Mülk Kimliğinizi nerede bulabileceğinize bakın. Toplu istekte, bu özellik belirtilmemiş veya toplu düzeyindeki özellikle tutarlı olmalıdır.

Ö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)
    }
  ],
  "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 verilerin tarih aralıkları. Birden fazla tarih aralığı istenirse her yanıt satırı sıfır tabanlı bir tarih aralığı dizini içerir. İki tarih aralığı çakışırsa çakışan günlere ait etkinlik verileri her iki tarih aralığının yanıt satırlarına eklenir. Grup isteğinde bu dateRanges belirtilmemiş olmalıdır.

dimensionFilter

object (FilterExpression)

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

metricFilter

object (FilterExpression)

Metriklerin filtre ifadesi. SQL'in yan tümcesine 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ıdır. İlk satır 0. satır olarak sayılır.

Sayfalara ayırma sırasında, ilk istek ofseti belirtmez veya eşdeğer olarak, ofseti 0'a ayarlar; ilk istek, ilk limit satır değerini döndürür. İkinci istek, ilk isteğin limit değerine göre ofseti ayarlar; ikinci istek, ikinci limit satır değerini döndürür.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfaları numaralandırma konusuna bakın.

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.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfaları numaralandırma konusuna bakın.

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.

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

Yanlış değerine ayarlanırsa veya belirtilmemişse tüm metriklerin 0'a eşit olduğu her satır döndürülmez. True (doğru) değerine ayarlanırsa bu satırlar bir filtre tarafından ayrıca kaldırılmazsa 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österilebilir.

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

returnPropertyQuota

boolean

Bu Analytics Mülkü'nün 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.

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