Method: properties.reportTasks.query

Bir rapor görevinin içeriğini alır. reportTasks.create isteğinde bulunduktan sonra, rapor ETKİN olduğunda rapor içeriğini alabilirsiniz. Bu yöntem, rapor görevinin durumu ACTIVE değilse 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ğı adı. Biçim: properties/{property}/reportTasks/{report}

İstek metni

İstek içeriği 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.

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ı. Raporun döndüreceği 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. QueryReportTaskRequest için kullanılabilen satır sayısı, ilişkili ReportTask'in sınırı ile daha da sınırlandırılı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 sayfalama parametresi hakkında daha fazla bilgi edinmek için Sayfalama başlıklı makaleyi inceleyin.

Yanıt metni

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

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