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.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
property

string

Zorunlu. 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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Alanlar
dimensions[]

object (Dimension)

İsteğe bağlı. İstenen ve görüntülenen boyutlar.
metrics[]

object (Metric)

İsteğe bağlı. İstenen ve gösterilen metrikler.
dateRanges[]

object (DateRange)

İsteğe bağlı. 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)

İsteğe bağlı. 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)

İsteğe bağlı. 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)

İsteğe bağlı. 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)

İsteğe bağlı. Döndürülecek maksimum 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)

İsteğe bağlı. 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)

İsteğe bağlı. 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

İsteğe bağlı. 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)

İsteğe bağlı. Bu istekle ilişkili grup. İstek içinde bir grup varsa "grup" boyutu bulunmalıdır.
keepEmptyRows

boolean

İsteğe bağlı. 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

İsteğe bağlı. 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.
conversionSpec

object (ConversionSpec)

İsteğe bağlı. Dönüşüm raporlamayı kontrol eder. Bu alan isteğe bağlıdır. Bu alan ayarlanırsa veya herhangi bir dönüşüm metriği istenirse rapor bir dönüşüm raporu olur.

Yanıt metni

Bir isteğe karşılık gelen yanıt raporu 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,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": 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. MetricHeader'ların sayısı ve MetricHeader'ların sıralaması, satırlarda bulunan metriklerle eşleşiyor.
rows[]

object (Row)

Rapordaki boyut değeri kombinasyonları ve metrik değerleri 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

Yanıt içinde döndürülen satır sayısından bağımsız olarak sorgu sonucundaki toplam satır sayısı. Örneğin, bir sorgu 175 satır döndürüyorsa ve API isteğinde limit = 50 yer alıyorsa yanıtta rowCount = 175 bulunur ancak yalnızca 50 satır yer alır.

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

object (ResponseMetaData)

Raporun meta verileri.
propertyQuota

object (PropertyQuota)

Bu Analytics mülkünün, bu isteği de içeren kota durumu.
kind

string

Bu mesajın ne tür bir kaynak olduğunu tanımlar. Bu kind her zaman sabit "analyticsData#runReport" dizesidir. JSON'daki yanıt türlerini ayırt etmek için kullanışlıdır.
nextPageToken

string

Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa yoktur.

Yetkilendirme kapsamları

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

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

Karşılaştırma

Bireysel bir karşılaştırmayı tanımlar. Çoğu istekte, raporun karşılaştırmalar arasında karşılaştırma yapabilmesi için birden fazla karşılaştırma yer alır.

JSON gösterimi 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Alanlar
name

string

Her karşılaştırma, yanıtta ayrı satırlar oluşturur. Yanıt, bu karşılaştırmayı bu adla tanımlar. Ad belirtilmemişse kaydedilen karşılaştırmaların görünen adı kullanılır.

one_comparison birleşik alanı.

one_comparison aşağıdakilerden yalnızca biri olabilir:
dimensionFilter

object (FilterExpression)

Temel bir karşılaştırma.
comparison

string

Karşılaştırmanın kaynak adıyla tanımlanan, kaydedilmiş bir karşılaştırma. Örneğin, "comparisons/1234".

ConversionSpec

Dönüşüm raporlamayı kontrol eder.

JSON gösterimi 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Alanlar
conversionActions[]

string

Rapora dahil edilecek dönüşüm işlemi kimlikleri. Boş bırakılırsa tüm dönüşümler dahil edilir. Geçerli dönüşüm işlemi kimlikleri, properties.getMetadata yönteminin yanıtındaki conversions listesindeki conversionAction alanından alınabilir. Örneğin, "conversionActions/1234".
attributionModel

enum (AttributionModel)

Dönüşüm raporunda kullanılacak ilişkilendirme modeli. Belirtilmezse DATA_DRIVEN kullanılır.

AttributionModel

Dönüşüm raporunda kullanılacak ilişkilendirme modeli

Sıralamalar
ATTRIBUTION_MODEL_UNSPECIFIED Belirtilmemiş ilişkilendirme modeli.
DATA_DRIVEN İlişkilendirme, ücretli ve organik veriye dayalı modele göre yapıldı
LAST_CLICK İlişkilendirme, ücretli ve organik son tıklama modeline göre yapılıyordu.