Method: properties.runReport

Menampilkan laporan yang disesuaikan dari data peristiwa Google Analytics Anda. Laporan berisi statistik yang berasal dari data yang dikumpulkan oleh kode pelacakan Google Analytics. Data yang ditampilkan dari API berupa tabel dengan kolom untuk dimensi dan metrik yang diminta. Metrik adalah pengukuran individual dari aktivitas pengguna di properti Anda, seperti pengguna aktif atau jumlah peristiwa. Dimensi mengelompokkan metrik di beberapa kriteria umum, seperti nama negara atau peristiwa.

Untuk panduan membuat permintaan & memahami respons, lihat Membuat Laporan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

ID properti GA4 Google Analytics yang peristiwanya dilacak. Ditetapkan di jalur URL, bukan di bagian 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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "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
dimensions[]

object (Dimension)

Dimensi yang diminta dan ditampilkan.
metrics[]

object (Metric)

Metrik yang diminta dan ditampilkan.
dateRanges[]

object (DateRange)

Rentang tanggal data untuk 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 harus tidak 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 SQL. Dimensi tidak dapat digunakan dalam filter ini.
offset

string (int64 format)

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

Saat melakukan paging, permintaan pertama tidak menentukan offset; atau yang setara, mengatur offset ke 0; permintaan pertama menampilkan limit baris pertama. Set permintaan kedua di-offset ke limit permintaan pertama; permintaan kedua akan menampilkan limit baris kedua.

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

string (int64 format)

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

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

enum (MetricAggregation)

Agregasi metrik. Nilai metrik gabungan akan ditampilkan di baris tempat dimensionValues ditetapkan ke "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Menentukan cara baris diurutkan dalam respons.
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, kolom 'kohor' dimensi kustom harus ada.
keepEmptyRows

boolean

Jika salah atau tidak ditentukan, tiap baris dengan semua metrik yang 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 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 saat ini dari kuota Properti Analytics ini. Kuota ditampilkan di PropertyQuota.
comparisons[]

object (Comparison)

Opsional. Konfigurasi perbandingan diminta dan ditampilkan. Permintaan hanya memerlukan kolom perbandingan agar dapat menerima kolom perbandingan dalam respons.

Isi respons

Jika berhasil, isi respons memuat instance RunReportResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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