Method: properties.batchRunReports

Menampilkan beberapa laporan dalam batch. Semua laporan harus untuk properti Google Analytics yang sama.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

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

Contoh: properties/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

object (RunReportRequest)

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

Isi respons

Respons batch yang berisi beberapa laporan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
Kolom
reports[]

object (RunReportResponse)

Respons individual. Setiap respons memiliki permintaan laporan terpisah.
kind

string

Mengidentifikasi jenis resource pesan ini. kind ini selalu berupa string tetap "analyticsData#batchRunReports". Berguna untuk membedakan 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

RunReportRequest

Permintaan untuk membuat laporan.

Representasi JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Kolom
property

string

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

Contoh: properties/1234
dimensions[]

object (Dimension)

Dimensi yang diminta dan ditampilkan.
metrics[]

object (Metric)

Metrik yang diminta dan ditampilkan.
dateRanges[]

object (DateRange)

Rentang tanggal data yang akan dibaca. Jika beberapa rentang tanggal diminta, setiap baris respons akan berisi indeks rentang tanggal berbasis nol. Jika dua rentang tanggal tumpang-tindih, data peristiwa untuk hari yang tumpang-tindih akan disertakan dalam baris respons untuk kedua rentang tanggal tersebut. Dalam permintaan kelompok, dateRanges ini tidak boleh ditentukan.
dimensionFilter

object (FilterExpression)

Filter dimensi memungkinkan Anda hanya meminta nilai dimensi tertentu dalam laporan. Untuk mempelajari lebih lanjut, lihat Dasar-Dasar Filter Dimensi untuk mengetahui contohnya. Metrik tidak dapat digunakan dalam filter ini.
metricFilter

object (FilterExpression)

Klausa filter metrik. Diterapkan setelah menggabungkan baris laporan, mirip dengan klausa having SQL. Dimensi tidak dapat digunakan dalam filter ini.
offset

string (int64 format)

Jumlah baris dari baris awal. Baris pertama dihitung sebagai baris 0.

Saat paging, permintaan pertama tidak menentukan offset; atau setara, 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)

Jumlah baris yang akan ditampilkan. 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. Misalnya, ada kurang dari 300 kemungkinan nilai untuk dimensi country, sehingga saat hanya melaporkan country, Anda tidak bisa mendapatkan lebih dari 300 baris, meskipun Anda menetapkan limit ke nilai yang lebih tinggi.

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

enum (MetricAggregation)

Agregasi metrik. Nilai metrik gabungan akan ditampilkan di baris dengan dimensionValues ditetapkan ke "RESERVED_(MetricAggregation)". Agregat yang mencakup perbandingan dan beberapa rentang tanggal akan digabungkan berdasarkan rentang tanggal.
orderBys[]

object (OrderBy)

Menentukan cara baris diurutkan dalam respons. Permintaan yang menyertakan perbandingan dan beberapa rentang tanggal akan memiliki urutan yang diterapkan pada perbandingan.
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 kohor yang terkait dengan permintaan ini. Jika ada grup kelompok dalam permintaan, dimensi 'kelompok' harus ada.
keepEmptyRows

boolean

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

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

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

boolean

Mengalihkan apakah akan menampilkan status kuota properti Google Analytics ini saat ini. Kuota ditampilkan di PropertyQuota.
comparisons[]

object (Comparison)

Opsional. Konfigurasi perbandingan yang diminta dan ditampilkan. Permintaan hanya memerlukan kolom perbandingan untuk menerima kolom perbandingan dalam respons.