Method: properties.batchRunPivotReports

Menampilkan beberapa laporan pivot dalam satu batch. Semua laporan harus untuk Properti GA4 yang sama.

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunPivotReports

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

ID properti GA4 Google Analytics yang peristiwanya dilacak. Ditentukan dalam jalur URL, bukan di bagian isi. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti. Properti ini harus ditentukan untuk batch. Properti dalam RunPivotReportRequest mungkin tidak ditentukan atau konsisten dengan properti ini.

Contoh: properti/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Kolom
requests[]

object (RunPivotReportRequest)

Permintaan individual. Setiap permintaan memiliki respons laporan pivot yang terpisah. Setiap permintaan batch diizinkan untuk hingga 5 permintaan.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons batch yang berisi beberapa laporan pivot.

Representasi JSON
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Kolom
pivotReports[]

object (RunPivotReportResponse)

Respons individual. Setiap respons memiliki permintaan laporan pivot yang terpisah.

kind

string

Mengidentifikasi jenis resource untuk pesan ini. kind selalu berupa string tetap "analyticsData#batchRunPivotReports". Berguna untuk membedakan berbagai jenis respons dalam JSON.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

RunPivotReportRequest

Permintaan untuk membuat laporan pivot.

Representasi JSON
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Kolom
property

string

ID properti GA4 Google Analytics yang peristiwanya dilacak. Ditentukan dalam jalur URL, bukan di bagian isi. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti. Dalam permintaan batch, properti ini harus tidak ditentukan atau konsisten dengan properti tingkat batch.

Contoh: properti/1234

dimensions[]

object (Dimension)

Dimensi yang diminta. Semua dimensi yang ditentukan harus digunakan oleh salah satu dari berikut ini: dimensionExpression, dimensionsFilter, pivots, orderBys.

metrics[]

object (Metric)

Metrik yang diminta, minimal satu metrik harus ditentukan. Semua metrik yang ditentukan harus digunakan oleh salah satu dari berikut: metric_expression, metricFilter, orderBys.

dateRanges[]

object (DateRange)

Rentang tanggal untuk mengambil data peristiwa untuk laporan. Jika beberapa rentang tanggal ditentukan, data peristiwa dari setiap rentang tanggal akan digunakan dalam laporan. Dimensi khusus dengan nama kolom "dateRange" dapat disertakan dalam nama kolom Pivot' jika disertakan, laporan akan membandingkan di antara rentang tanggal. Dalam permintaan kelompok, dateRanges ini tidak harus ditentukan.

pivots[]

object (Pivot)

Menjelaskan format visual dimensi laporan dalam kolom atau baris. Gabungan kolomNames (nama dimensi) di semua pivot harus merupakan subset nama dimensi yang ditentukan dalam Dimensi. Tidak ada dua pivot yang dapat berbagi dimensi. Dimensi hanya terlihat jika muncul dalam pivot.

dimensionFilter

object (FilterExpression)

Klausa filter dimensi. Dimensi harus diminta untuk digunakan dalam filter ini. Metrik tidak dapat digunakan dalam filter ini.

metricFilter

object (FilterExpression)

Klausa filter metrik. Diterapkan pada fase pasca-agregasi, mirip dengan SQL yang memiliki klausa. Metrik harus diminta untuk digunakan dalam filter ini. Dimensi tidak dapat digunakan di filter ini.

currencyCode

string

Kode mata uang dalam format ISO4217, seperti "AED", "USD", "JPY". Jika kolom kosong, laporan akan menggunakan mata uang default properti.

cohortSpec

object (CohortSpec)

Grup kelompok yang terkait dengan permintaan ini. Jika ada grup kelompok dalam permintaan, dimensi 'cohort' harus ada.

keepEmptyRows

boolean

Jika salah atau tidak ditentukan, setiap baris dengan semua metrik yang sama dengan 0 tidak akan ditampilkan. Jika benar, baris ini akan ditampilkan jika tidak dihapus secara terpisah oleh filter.

returnPropertyQuota

boolean

Mengalihkan apakah akan menampilkan status kuota Properti Analytics saat ini. Kuota ditampilkan di PropertyQuota.