Method: properties.reportTasks.query

Mengambil konten tugas laporan. Setelah meminta reportTasks.create, Anda dapat mengambil konten laporan setelah laporan AKTIF. Metode ini akan menampilkan error jika status tugas laporan bukan ACTIVE. Respons kueri akan menampilkan nilai baris &kolom tabel laporan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama sumber laporan. Format: properties/{property}/reportTasks/{report}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "offset": string,
  "limit": string
}
Kolom
offset

string (int64 format)

Opsional. Jumlah baris baris awal dalam laporan. Baris pertama dihitung sebagai baris 0.

Saat melakukan penomoran halaman, permintaan pertama tidak menentukan offset; atau setara dengan menetapkan offset ke 0; permintaan pertama menampilkan limit baris pertama. Permintaan kedua menetapkan offset ke limit permintaan pertama; permintaan kedua menampilkan limit baris kedua.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran Halaman.
limit

string (int64 format)

Opsional. Jumlah baris yang akan ditampilkan dari laporan. Jika tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. limit harus positif.

API juga dapat menampilkan lebih sedikit baris daripada limit yang diminta, jika tidak ada nilai dimensi sebanyak limit. Jumlah baris yang tersedia untuk QueryReportTaskRequest lebih dibatasi oleh batas ReportTask terkait. Kueri dapat mengambil paling banyak baris ReportTask.limit. Misalnya, jika ReportTask memiliki batas 1.000, permintaan reportTasks.query dengan offset=900 dan limit=500 akan menampilkan paling banyak 100 baris.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran Halaman.

Isi respons

Konten laporan yang sesuai dengan tugas laporan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  }
}
Kolom
dimensionHeaders[]

object (DimensionHeader)

Menjelaskan kolom dimensi. Jumlah DimensionHeaders dan urutan DimensionHeaders cocok dengan dimensi yang ada di baris.
metricHeaders[]

object (MetricHeader)

Menjelaskan kolom metrik. Jumlah MetricHeaders dan urutan MetricHeaders cocok dengan metrik yang ada di baris.
rows[]

object (Row)

Baris kombinasi nilai dimensi dan nilai metrik dalam laporan.
totals[]

object (Row)

Jika diminta, nilai metrik yang dijumlahkan.
maximums[]

object (Row)

Jika diminta, nilai maksimum metrik.
minimums[]

object (Row)

Jika diminta, nilai minimum metrik.
rowCount

integer

Jumlah total baris dalam hasil kueri.
metadata

object (ResponseMetaData)

Metadata untuk laporan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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