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ı olan bir tablo şeklindedir. Metrikler, mülkünüzdeki kullanıcı etkinliğinin tek tek ö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 ayrıntılandırır.

İstek 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. URL yolunda belirtilir, gövdede belirtilmez. Daha fazla bilgi için Mülk kimliğinizi nerede bulabileceğinizi öğrenin. Toplu istekte bu özellik belirtilmemiş olmalı veya toplu düzeydeki özellik ile tutarlı olmalıdır.

Örnek: properties/1234

İstek metni

İstek içeriği 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österilen 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ığı indeksi içerir. İki tarih aralığı çakışıyorsa çakışan günlerin etkinlik verileri, her iki tarih aralığının yanıt satırlarına dahil edilir. 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 başlıklı makaledeki örneklere göz atın. Metrikler bu filtrede kullanılamaz.

metricFilter

object (FilterExpression)

Metriklerin filtre ifadesi. Raporun satırları toplandıktan sonra uygulanır. SQL having-clause'a benzer. Bu filtrede boyutlar 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.

Sayfalama sırasında ilk istekte ofset belirtilmez veya ofset 0 olarak ayarlanır. İlk istek, satırların ilk limit'sini döndürür. İkinci istek, ilk isteğin limit değerini ofset olarak ayarlar. İkinci istek, satırların ikinci limit değerini döndürür.

Bu sayfalama parametresi hakkında daha fazla bilgi edinmek için Sayfalama başlıklı makaleyi inceleyin.

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.

API, limit kadar boyut değeri yoksa 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 elde edemezsiniz.

Bu sayfalama parametresi hakkında daha fazla bilgi edinmek için Sayfalama başlıklı makaleyi inceleyin.

metricAggregations[]

enum (MetricAggregation)

Metriklerin toplanması. Toplanan metrik değerleri, boyut değerlerinin "RESERVED_(MetricAggregation)" olarak ayarlandığı satırlarda gösterilir. Hem karşılaştırmaları hem de birden fazla tarih aralığını içeren toplamalar, tarih aralıklarına göre toplanır.

orderBys[]

object (OrderBy)

Yanıttaki satırların nasıl sıralandığını belirtir. Hem karşılaştırmaları hem de birden fazla tarih aralığını içeren isteklerde, karşılaştırmalara göre sıralama uygulanır.

currencyCode

string

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

cohortSpec

object (CohortSpec)

Bu istekle ilişkili grup. İstek içinde bir grup varsa "grup" boyutu bulunmalıdır.

keepEmptyRows

boolean

Yanlışsa veya belirtilmemişse tüm metrikleri 0'a eşit olan her satır döndürülmez. Doğruysa bu satırlar, bir filtre tarafından ayrı olarak kaldırılmadıkları sürece döndürülür.

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

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

returnPropertyQuota

boolean

Bu Google Analytics mülkünün kotasının mevcut durumunun döndürülüp döndürülmeyeceğini değiştirir. 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ıtın karşılaştırma sütunu içermesi için istekte yalnızca bir karşılaştırma alanı olması gerekir.

Yanıt metni

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