Method: properties.reportTasks.query

Rapor görevinin içeriğini alır. reportTasks.create isteğinde bulunduktan sonra, rapor ETKİN olduğunda rapor içeriğini alabilirsiniz. Rapor görevinin durumu ACTIVE değilse bu yöntem hata döndürür. Bir sorgu yanıtı, tablo şeklinde bir satır ve raporun sütun değerleridir.

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

Sayfalara ayırma sırasında ilk istek ofseti belirtmez; veya eşdeğer olarak, ofseti 0'a ayarlar; ilk istek, satırların ilk limit tanesini döndürür. İkinci istek, ilk isteğin limit farkını 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 Sayfalara ayırma bölümüne bakın.

limit

string (int64 format)

İsteğe bağlı. Rapordan döndürülecek satır sayısı. Belirtilmezse 10.000 satır döndürülür. API, istediğiniz sayıda satırdan bağımsız olarak istek başına en fazla 250.000 satır döndürür. limit pozitif olmalıdır.

Ayrıca, limit kadar boyut değeri yoksa API, istenen limit değerinden daha az satır döndürebilir. Bir QueryRaporTaskRequest için kullanılabilecek 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 1000 sınırı varsa 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 Sayfalara ayırma bölümüne bakın.

Yanıt gövdesi

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şir.

metricHeaders[]

object (MetricHeader)

Metrik sütunlarını açıklar. MetricHeaders'ların sayısı ve MetricHeaders'ların sıralaması, satırlarda bulunan metriklerle eşleşir.

rows[]

object (Row)

Rapordaki boyut değeri kombinasyonları ve metrik değerlerinin satırları.

totals[]

object (Row)

İstenirse metriklerin toplam değerleri.

maximums[]

object (Row)

İstenirse maksimum metrik değerleri.

minimums[]

object (Row)

İstenirse minimum metrik 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

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

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

boolean

Değer true ise bazı boyut kombinasyonu gruplarının "(other)" olarak toplandığını belirtir. satırı. 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 filtrelerden ve sınırlardan bağımsız olarak doğru şekilde doldurulur.

Örneğin, istek sessionSource = google ayarında bir filtre içerdiğinden (other) satırı rapordan çıkarılabilir. Bu raporu oluşturmak için kullanılan giriş birleştirilmiş 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 başlıklı makaleyi inceleyin.

schemaRestrictionResponse

object (SchemaRestrictionResponse)

Bu rapor oluşturulurken 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. Görselleştirme için purchaseRevenue gibi para birimi metriklerini biçimlendirmede kullanılmak üzere tasarlanmıştır. İstekte currencyCode belirtildiyse bu yanıt parametresi istek parametresini yansıtır; Aksi takdirde, bu yanıt parametresi mülkün mevcut 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 için https://support.google.com/analytics/answer/9796179 adresini ziyaret edin.

timeZone

string

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

emptyReason

string

Boş bir neden belirtilirse rapor bu nedenle boş olur.

subjectToThresholding

boolean

subjectToThresholding doğru ise bu rapor eşiğe tabi tutulur ve yalnızca minimum toplama eşiklerini karşılayan verileri döndürür. Bir istek eşik eşiğine tabi tutulabilir ve raporda hiçbir veri bulunmaz. 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ümlerini inceleyin.

SchemaRestrictionResponse

Bu raporun oluşturulmasında şema kısıtlamaları etkin bir şekilde uygulanır. 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 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 ürününe erişime 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 metriğin kısıtlamasının nedeni.

metricName

string

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

RestrictedMetricType

Belirli GA4 mülklerinde görüntülemenizin kısıtlanabileceği veri kategorileri.

Sıralamalar
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tür belirtilmedi.
COST_DATA adCost gibi maliyet metrikleri.
REVENUE_DATA purchaseRevenue gibi gelir metrikleri.