Method: properties.reportTasks.query

Bir rapor görevinin içeriğini alır. reportTasks.create için istekte bulunduktan sonra, rapor ETKİN duruma geldikten sonra rapor içeriğini alabilirsiniz. Rapor görevinin durumu ACTIVE değilse bu yöntem bir hata döndürür. Sorgu yanıtı, raporun tablo 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

İsteğin gövdesi, aşağıdaki yapıya sahip veriler 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.

Sayfalara ayırma sırasında, ilk istek ofseti belirtmez veya eşdeğer olarak ofseti 0 değerine ayarlar; ilk istek satırların ilk limit değerini döndürür. İkinci istek, ofseti ilk isteğin limit değerine ayarlar; ikinci istek, satırların ikinci limit 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)

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

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfaları numaralandırma konusuna 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 öğesinin sıralaması, satırlarda bulunan boyutlarla eşleşir.
metricHeaders[]

object (MetricHeader)

Metrik sütunlarını açıklar. MetricHeaders'ın sayısı ve MetricHeaders'ın sıralaması, satırlardaki metriklerle eşleşir.
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

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

object (ResponseMetaData)

Raporla ilgili meta veriler.

Yetkilendirme kapsamları

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

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

ResponseMetaData

Yanıtın meta verileri, rapor içeriği hakkında ek bilgiler içerir.

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

boolean

Doğru değeri, bazı boyut kombinasyonu gruplarının "(diğer)" satırında toplandığını 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 filtreler ve sınırlardan bağımsız olarak doğru şekilde doldurulur.

Örneğin, istek sessionSource = google ile ilgili bir filtre içerdiğinden (other) satırı rapordan çıkarılabilir. Bu raporu oluşturmak için kullanılan birleştirilmiş giriş verilerinde diğer satırdan veri kaybı varsa bu parametre yine de doldurulur.

Daha fazla bilgi edinmek için (other) satırı ve veri örnekleme hakkında bölümünü inceleyin.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Bu raporu oluştururken etkin bir şekilde 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. purchaseRevenue gibi para birimi metriklerinin görselleştirme amacıyla biçimlendirilmesinde kullanılmak üzere tasarlanmıştır. İstekte currencyCode belirtilmişse bu yanıt parametresi istek parametresini; aksi takdirde, bu yanıt parametresi mülkün geçerli currencyCode'u olur.

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 için https://support.google.com/analytics/answer/9796179 adresini inceleyin.
timeZone

string

Mülkün geçerli saat dilimi. hour ve minute gibi zamana dayalı boyutları yorumlamak için tasarlanmıştır. IANA Saat Dilimi veritabanından (https://www.iana.org/time-zones) alınan dizeler olarak biçimlendirilmiştir; örneğin, "America/New_York" veya "Asya/Tokyo".
emptyReason

string

Neden boş bırakılırsa rapor bu nedenle boş olur.
subjectToThresholding

boolean

subjectToThresholding değeri doğruysa bu rapor eşiğe tabidir ve yalnızca minimum toplama eşiklerini karşılayan verileri döndürür. Bir istek eşik eşiğine tabi olabilir ve raporda hiçbir veri eksik olmayabilir. Bu durum, tüm veriler eşiklerin üzerinde olduğunda gerçekleşir. Daha fazla bilgi edinmek için Veri eşikleri ile Demografi ve İlgi Alanları Hakkında bölümlerine bakın.

SchemaRestrictionResponse

Bu raporu oluştururken etkin şekilde 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 tüm kısıtlamalar etkin bir şekilde uygulanır. Örneğin, purchaseRevenue için kısıtlama türü her zaman REVENUE_DATA olur. Ancak bu etkin yanıt kısıtlaması yalnızca kullanıcının özel rolü REVENUE_DATA erişimine izin vermiyorsa doldurulur.

ActiveMetricRestriction

Rapor oluşturulurken aktif olarak kısıtlanmış bir metriktir.

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

enum (RestrictedMetricType)

Bu metrikle ilgili kısıtlamanın nedeni.
metricName

string

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

RestrictedMetricType

Belirli GA4 mülklerinde görüntülemeniz kısıtlanabilecek veri kategorileri.

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