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 ve metrikler için sütunlar içeren bir tablo şeklindedir. Metrikler, mülkünüzde gerçekleşen kullanıcı etkinliklerinin (ör. etkin kullanıcı sayısı veya etkinlik sayısı) ayrı ayrı ölçümleridir. Boyutlar, metrikleri ülke veya etkinlik adı gibi bazı ortak ölçütlere göre ayırır.

İstekler oluşturma ve yanıtları anlama kılavuzu 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 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. Bu özellik, toplu istek içinde belirtilmemiş veya toplu düzeydeki mülkle tutarlı olmalıdır.

Ö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)
    }
  ],
  "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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
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 dahil edilir. Bir kohort 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 örnekleri içeren Boyut Filtrelerinin Temel Özellikleri başlıklı makaleyi inceleyin. Metrikler bu filtrede kullanılamaz.

metricFilter

object (FilterExpression)

Metriklerin filtre ifadesi. SQL having yan tümcesine benzer şekilde, raporun 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.

Sayfalandırmada ilk istek, ofseti belirtmez veya eşdeğer olarak ofseti 0 olarak ayarlar. İlk istek, ilk limit satırı döndürür. İkinci istek, ofseti ilk isteğinin limit değerine ayarlar; ikinci istek, satırların ikinci limit değerini döndürür.

Bu sayfalandırma parametresi hakkında daha fazla bilgi edinmek için Sayfalandırma bölümüne 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 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.

Bu sayfalandırma parametresi hakkında daha fazla bilgi edinmek için Sayfalandırma bölümüne bakın.

metricAggregations[]

enum (MetricAggregation)

Metriklerin toplanması. Toplu metrik değerleri, dimensionValues'ın "RESERVED_(MetricAggregation)" olarak ayarlandığı satırlarda gösterilir. Hem karşılaştırmaları hem de birden fazla tarih aralığını içeren toplama işlemleri, tarih aralıklarını temel alarak toplanır.

orderBys[]

object (OrderBy)

Satırların yanıtta nasıl sıralandığını belirtir. Hem karşılaştırmalar hem de birden fazla tarih aralığı içeren isteklerde, karşılaştırmalara sıralama uygulanır.

currencyCode

string

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

cohortSpec

object (CohortSpec)

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

keepEmptyRows

boolean

Yanlış veya belirtilmemişse tüm metrikleri 0 olan her satır döndürülmez. Doğru ise bir filtre tarafından ayrı olarak kaldırılmazlarsa bu satırlar döndürülür.

Bu keepEmptyRows ayarından bağımsız olarak, raporlarda yalnızca Google Analytics mülkü tarafından kaydedilen veriler gösterilebilir.

Örneğin, bir mülk hiçbir zaman purchase etkinliği günlüğe kaydetmezse eventName boyutu ve eventCount metriği için bir sorgu, eventName: "purchase" ve eventCount: 0 satırına sahip olmaz.

returnPropertyQuota

boolean

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

comparisons[]

object (Comparison)

İsteğe bağlı. İstenen ve görüntülenen karşılaştırmaların yapılandırması. Yanıtta bir karşılaştırma sütunu almak için istekte yalnızca bir karşılaştırma alanı gerekir.

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