Menampilkan laporan data peristiwa Google Analytics yang disesuaikan. Laporan berisi statistik yang berasal dari data yang dikumpulkan oleh kode pelacakan Google Analytics. Data yang ditampilkan dari API adalah sebagai tabel dengan kolom untuk dimensi dan metrik yang diminta. Metrik adalah pengukuran individual terhadap aktivitas pengguna di properti Anda, seperti pengguna aktif atau jumlah peristiwa. Dimensi mengelompokkan metrik di beberapa kriteria umum, seperti negara atau nama 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 |
ID properti GA4 Google Analytics yang peristiwanya dilacak. Ditentukan dalam jalur URL dan bukan 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 |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "dimensions": [ { object ( |
Kolom | |
---|---|
dimensions[] |
Dimensi yang diminta dan ditampilkan. |
metrics[] |
Metrik yang diminta dan ditampilkan. |
dateRanges[] |
Rentang tanggal data untuk dibaca. Jika ada beberapa rentang tanggal yang 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, |
dimensionFilter |
Filter dimensi memungkinkan Anda meminta hanya 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 |
Klausa filter metrik. Diterapkan setelah menggabungkan baris laporan, mirip dengan klausa memiliki SQL. Dimensi tidak dapat digunakan dalam filter ini. |
offset |
Jumlah baris dari baris awal. Baris pertama dihitung sebagai baris 0. Saat paging, permintaan pertama tidak menentukan offset; atau dengan cara yang setara, menetapkan offset ke 0; permintaan pertama menampilkan Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman. |
limit |
Jumlah baris yang perlu ditampilkan. Jika tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. API juga dapat menampilkan baris yang lebih sedikit dari Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman. |
metricAggregations[] |
Agregasi metrik. Nilai metrik gabungan akan ditampilkan di baris tempat dimensionsValues ditetapkan ke "RESERVED_(MetricAgregasi)". |
orderBys[] |
Menentukan bagaimana baris diurutkan dalam respons. |
currencyCode |
Kode mata uang dalam format ISO4217, seperti "AED", "USD", "JPY". Jika kolom kosong, laporan akan menggunakan mata uang default properti. |
cohortSpec |
Grup kohor yang dikaitkan dengan permintaan ini. Jika ada grup kelompok dalam permintaan, dimensi 'kohor' harus ada. |
keepEmptyRows |
Jika salah (false) 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. Terlepas dari setelan Misalnya jika properti tidak pernah mencatat peristiwa |
returnPropertyQuota |
Beralih apakah akan menampilkan status kuota Properti Analytics saat ini atau tidak. Kuota ditampilkan dalam PropertyQuota. |
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