Method: properties.runRealtimeReport

Menampilkan laporan data peristiwa realtime yang disesuaikan untuk properti Anda. Peristiwa muncul di laporan realtime beberapa detik setelah dikirim ke Google Analytics. Laporan Real-Time menampilkan peristiwa dan data penggunaan selama jangka waktu mulai dari momen saat ini hingga 30 menit yang lalu (hingga 60 menit untuk properti Google Analytics 360).

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

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1beta/{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, bukan di bagian isi. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti.

Contoh: properti/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

object (Dimension)

Dimensi yang diminta dan ditampilkan.
metrics[]

object (Metric)

Metrik yang diminta dan ditampilkan.
dimensionFilter

object (FilterExpression)

Klausa filter dimensi. Metrik tidak dapat digunakan dalam filter ini.
metricFilter

object (FilterExpression)

Klausa filter metrik. Diterapkan pada fase pasca-agregasi, mirip dengan SQL yang memiliki klausa. Dimensi tidak dapat digunakan di filter ini.
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.
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.
returnPropertyQuota

boolean

Mengalihkan apakah akan menampilkan status kuota Realtime Properti Analytics saat ini. Kuota ditampilkan di PropertyQuota.
minuteRanges[]

object (MinuteRange)

Rentang menit data peristiwa untuk dibaca. Jika tidak ditentukan, rentang satu menit selama 30 menit terakhir akan digunakan. Jika rentang beberapa menit diminta, setiap baris respons akan berisi indeks rentang menit berbasis nol. Jika rentang dua menit tumpang tindih, data peristiwa untuk menit yang tumpang tindih disertakan dalam baris respons untuk kedua rentang menit tersebut.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Tabel laporan realtime 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)
  },
  "kind": string
}
Kolom
dimensionHeaders[]

object (DimensionHeader)

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

object (MetricHeader)

Menjelaskan kolom metrik. Jumlah MetricHeaders dan pengurutan MetricHeaders cocok dengan metrik yang ada di 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 maksimum metrik.
minimums[]

object (Row)

Jika diminta, nilai minimum metrik.
rowCount

integer

Jumlah total baris dalam hasil kueri. rowCount tidak bergantung pada jumlah baris yang ditampilkan dalam respons dan parameter permintaan limit. 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.
kind

string

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

Rentang Menit

Kumpulan menit yang berdekatan: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Permintaan diizinkan hingga rentang 2 menit.

Representasi JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Kolom
name

string

Menetapkan nama untuk rentang menit ini. Dimensi dateRange bernilai nama ini dalam respons laporan. Jika ditetapkan, tidak boleh diawali dengan date_range_ atau RESERVED_. Jika tidak disetel, rentang menit diberi nama berdasarkan indeks berbasis nol dalam permintaan: date_range_0, date_range_1, dll.
startMinutesAgo

integer

Menit mulai inklusif untuk kueri selama beberapa menit sebelumnya. Misalnya, "startMinutesAgo": 29 menentukan bahwa laporan harus menyertakan data peristiwa dari 29 menit yang lalu dan setelahnya. Tidak boleh setelah endMinutesAgo.

Jika tidak ditentukan, nilai startMinutesAgo akan ditetapkan secara default ke 29. Properti Analytics standar dapat meminta hingga 30 menit terakhir data peristiwa (startMinutesAgo <= 29), dan properti Analytics 360 dapat meminta hingga 60 menit terakhir data peristiwa (startMinutesAgo <= 59).
endMinutesAgo

integer

Menit akhir inklusif untuk kueri sebagai jumlah menit sebelumnya. Tidak boleh sebelum startMinutesAgo. Misalnya, "endMinutesAgo": 15 menentukan bahwa laporan harus menyertakan data peristiwa dari sebelum 15 menit yang lalu.

Jika tidak ditentukan, setelan defaultnya adalah endMinutesAgo. Properti Analytics standar dapat meminta menit apa pun dalam data peristiwa 30 menit terakhir (endMinutesAgo <= 29), dan properti Analytics 360 dapat meminta menit apa pun dalam data peristiwa 60 menit terakhir (endMinutesAgo <= 59).