Halaman ini diterjemahkan oleh Cloud Translation API.

Method: properties.runReport

Permintaan HTTP
Parameter jalur
Isi permintaan
- Representasi JSON
Isi respons
Cakupan Otorisasi
Cobalah

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 ini adalah tabel dengan kolom untuk dimensi dan metrik yang diminta. Metrik adalah pengukuran masing-masing 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

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. Dalam permintaan batch, properti ini harus tidak ditentukan atau konsisten dengan properti tingkat batch. Contoh: properti/1234

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON

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 }

{
  "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
}

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 disertakan dalam baris respons untuk kedua rentang tanggal tersebut. Dalam permintaan kelompok, `dateRanges` ini tidak harus ditentukan.
`dimensionFilter`	`object (FilterExpression)` Filter dimensi memungkinkan Anda untuk 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 SQL yang memiliki klausa. Dimensi tidak dapat digunakan di filter ini.
`offset`	`string (int64 format)` Jumlah baris untuk baris awal. Baris pertama dihitung sebagai baris 0. Saat melakukan paging, permintaan pertama tidak menentukan offset; atau setara, menyetel offset ke 0; permintaan pertama menampilkan `limit` baris pertama. Permintaan kedua menyetel 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 tersebut menampilkan maksimum 100.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 jumlah nilai dimensi sebanyak `limit`. Misalnya, ada kurang dari 300 kemungkinan nilai untuk dimensi `country`, sehingga saat melaporkan hanya di `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)` Gabungan metrik. Nilai metrik gabungan akan ditampilkan di baris dengan 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, 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.

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