Method: properties.batchRunPivotReports

Menampilkan beberapa laporan pivot dalam 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 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: properties/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 terpisah. Setiap permintaan batch diizinkan 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 yang digunakan 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 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: properties/1234
dimensions[]

object (Dimension)

Dimensi yang diminta. Semua dimensi yang ditentukan harus digunakan oleh salah satu hal berikut: dimensionsExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

Metrik yang diminta, minimal satu metrik harus ditentukan. Semua metrik yang ditentukan harus digunakan oleh salah satu hal 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 antar-rentang tanggal. Dalam permintaan kelompok, dateRanges ini harus ditentukan.
pivots[]

object (Pivot)

Menjelaskan format visual dimensi laporan dalam kolom atau baris. Penyatuan fieldNames (nama dimensi) di semua pivot harus berupa subset nama dimensi yang didefinisikan 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 agar digunakan dalam filter ini. Metrik tidak dapat digunakan di filter ini.
metricFilter

object (FilterExpression)

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

string

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

object (CohortSpec)

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

boolean

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

Terlepas dari setelan keepEmptyRows ini, hanya data yang dicatat oleh properti Google Analytics (GA4) yang dapat ditampilkan dalam laporan.

Misalnya, jika properti tidak pernah mencatat peristiwa purchase, kueri untuk dimensi eventName dan metrik eventCount tidak akan memiliki baris eventName: "purchase" dan eventCount: 0.
returnPropertyQuota

boolean

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