Method: properties.runRealtimeReport

Google Analytics Realtime API menampilkan laporan yang disesuaikan berisi data peristiwa realtime untuk properti Anda. Laporan ini menunjukkan peristiwa dan penggunaan selama 30 menit terakhir.

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

ID properti GA4 Google Analytics yang peristiwanya dilacak. Ditentukan dalam jalur URL dan bukan isi. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti.

Contoh: properties/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Kolom
dimensions[]

object (Dimension)

Dimensi yang diminta dan ditampilkan.
metrics[]

object (Metric)

Metrik yang diminta dan ditampilkan.
limit

string (int64 format)

Jumlah baris yang akan ditampilkan. Jika parameter limit tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 100.000 baris per permintaan, berapa pun jumlah yang Anda minta.
dimensionFilter

object (FilterExpression)

Klausa filter dimensi. Dimensi harus diminta untuk digunakan dalam filter ini. Metrik tidak dapat digunakan dalam filter ini.
metricFilter

object (FilterExpression)

Klausa filter metrik. Diterapkan pada fase agregasi pasca, mirip dengan klausa penggunaan SQL. Metrik harus diminta untuk digunakan dalam filter ini. Dimensi tidak dapat digunakan dalam filter ini.
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

Menentukan bagaimana baris diurutkan dalam respons.
returnPropertyQuota

boolean

Beralih apakah akan menampilkan status saat ini dari kuota Realtime Properti Analytics ini. Kuota ditampilkan di PropertyQuota.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Tabel laporan real-time respons yang sesuai dengan permintaan.

Representasi JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
Kolom
dimensionHeaders[]

object (DimensionHeader)

Menjelaskan kolom dimensi. Jumlah DimensionHeader dan urutan DimensionHeaders cocok dengan dimensi yang ada dalam baris.
metricHeaders[]

object (MetricHeader)

Menjelaskan kolom metrik. Jumlah MetricHeader dan pengurutan MetricHeaders cocok dengan metrik yang ada dalam baris.
rows[]

object (Row)

Baris kombinasi nilai dimensi dan nilai metrik dalam laporan.
totals[]

object (Row)

Jika diminta, total nilai metrik.
maximums[]

object (Row)

Jika diminta, nilai metrik maksimum.
minimums[]

object (Row)

Jika diminta, nilai metrik minimum.
rowCount

integer

Jumlah total baris dalam hasil kueri, berapa pun jumlah baris yang ditampilkan dalam respons. Misalnya, jika kueri menampilkan 175 baris dan menyertakan limit = 50 dalam permintaan API, respons akan berisi rowCount = 175, tetapi hanya 50 baris.
propertyQuota

object (PropertyQuota)

Status kuota Realtime Properti Analytics ini termasuk permintaan ini.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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