Method: properties.reportTasks.query

Bir rapor görevinin içeriğini alır. reportTasks.create'ü talep ettikten sonra, rapor etkin hale geldiğinde rapor içeriğini alabilirsiniz. Rapor görevinin durumu ACTIVE değilse bu yöntem hata döndürür. Sorgu yanıtı, raporun tablo biçimindeki satır ve sütun değerlerini döndürür.

HTTP isteği

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

Yol parametreleri

Parametreler
name

string

Zorunlu. Rapor kaynağının adı. Biçim: properties/{property}/reportTasks/{report}

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "offset": string,
  "limit": string
}
Alanlar
offset

string (int64 format)

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

İsteğe bağlı. Rapordan 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. QueryReportTaskRequest için kullanılabilen satır sayısı, ilişkili ReportTask sınırıyla da sınırlıdır. Bir sorgu en fazla ReportTask.limit satırını alabilir. Örneğin, ReportTask'ın sınırı 1.000 ise offset=900 ve limit=500 olan bir reportTasks.query isteği en fazla 100 satır döndürür.

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

Yanıt gövdesi

Bir rapor görevine karşılık gelen rapor içeriği.

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)
  }
}
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. MetricHeaders sayısı ve MetricHeaders'ın sıralaması, satırlarda bulunan metriklerle eşleşiyor.
rows[]

object (Row)

Rapordaki boyut değeri kombinasyonlarının ve metrik değerlerinin bulunduğu 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

Sorgu sonucundaki toplam satır sayısı.
metadata

object (ResponseMetaData)

Raporun meta verileri.

Yetkilendirme kapsamları

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

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

ResponseMetaData

Rapor içeriği hakkında ek bilgiler içeren yanıtın meta verileri.

JSON gösterimi 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Alanlar
dataLossFromOtherRow

boolean

Doğru ise bazı boyut kombinasyonu gruplarının "(other)" satırına dahil edildiğini gösterir. Bu durum, yüksek kardinaliteli raporlarda görülebilir.

dataLossFromOtherRow meta veri parametresi, raporda kullanılan birleştirilmiş veri tablosuna göre doldurulur. Parametre, rapordaki filtrelere ve sınırlara bakılmaksızın doğru şekilde doldurulur.

Örneğin, istek sessionSource = google üzerinde bir filtre içerdiğinden (other) satırı rapordan çıkarılabilir. Bu rapor oluşturulurken kullanılan giriş toplu verilerinde başka bir satırdan veri kaybı varsa bu parametre yine doldurulur.

Daha fazla bilgi edinmek için (other) satırı ve veri örnekleme hakkında başlıklı makaleyi inceleyin.
samplingMetadatas[]

object (SamplingMetadata)

Bu rapor sonuçları örneklenmişse bu raporda kullanılan etkinliklerin yüzdesini gösterir. Her tarih aralığı için bir samplingMetadatas doldurulur. Her samplingMetadatas, istekte belirtildiği üzere bir tarih aralığına karşılık gelir.

Ancak sonuçlar örneklenmezse bu alan tanımlanmaz.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Bu raporun oluşturulmasında etkin olarak uygulanan şema kısıtlamalarını açıklar. Daha fazla bilgi edinmek için Erişim ve veri kısıtlama yönetimi başlıklı makaleyi inceleyin.
currencyCode

string

Bu raporda kullanılan para birimi kodu. Görselleştirme için purchaseRevenue gibi para birimi metriklerinin biçimlendirilmesinde kullanılması amaçlanmıştır. currencyCode istekte belirtilmişse bu yanıt parametresi istek parametresini yansıtır. Aksi takdirde bu yanıt parametresi, mülkün geçerli currencyCode değeridir.

Para birimi kodları, ISO 4217 standardındaki (https://en.wikipedia.org/wiki/ISO_4217) para birimi türlerinin dize kodlamalarıdır. Örneğin, "USD", "EUR", "JPY". Daha fazla bilgi edinmek için https://support.google.com/analytics/answer/9796179 adresini inceleyin.
timeZone

string

Tesisin şu anki saat dilimi. hour ve minute gibi zamana dayalı boyutları yorumlamak için kullanılması amaçlanmıştır. IANA Saat Dilimi veritabanındaki (https://www.iana.org/time-zones) dize biçimindedir. Örneğin, "America/New_York" veya "Asia/Tokyo".
emptyReason

string

Boş neden belirtilirse rapor bu nedenle boştur.
subjectToThresholding

boolean

subjectToThresholding doğruysa bu rapora eşik uygulanır ve yalnızca minimum toplama eşiklerini karşılayan veriler döndürülür. Bir isteğin eşiklere tabi olması ve raporda hiçbir verinin bulunmaması mümkündür. Bu durum, tüm veriler eşiklerin üzerinde olduğunda gerçekleşir. Daha fazla bilgi edinmek için Veri eşikleri ve Demografik Gruplar ve İlgi Alanları hakkında başlıklı makaleleri inceleyin.

SchemaRestrictionResponse

Bu raporun oluşturulması sırasında etkin olarak uygulanan şema kısıtlamaları. Daha fazla bilgi edinmek için Erişim ve veri kısıtlama yönetimi başlıklı makaleyi inceleyin.

JSON gösterimi 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Alanlar
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Rapor oluşturulurken etkin olarak uygulanan tüm kısıtlamalar. Örneğin, purchaseRevenue her zaman REVENUE_DATA kısıtlama türüne sahiptir. Ancak bu etkin yanıt kısıtlaması yalnızca kullanıcının özel rolü REVENUE_DATA'e erişime izin vermiyorsa doldurulur.

ActiveMetricRestriction

Rapor oluşturulurken etkin olarak kısıtlanmış bir metrik.

JSON gösterimi 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Alanlar
restrictedMetricTypes[]

enum (RestrictedMetricType)

Bu metriğin kısıtlanmasının nedeni.
metricName

string

Kısıtlanmış metriğin adı.

RestrictedMetricType

Belirli Google Analytics mülklerinde görüntülemenize kısıtlama getirilebilecek veri kategorileri.

Sıralamalar
RESTRICTED_METRIC_TYPE_UNSPECIFIED Belirtilmemiş tür.
COST_DATA adCost gibi maliyet metrikleri.
REVENUE_DATA purchaseRevenue gibi gelir metrikleri.