Halaman ini diterjemahkan oleh Cloud Translation API.

Method: properties.runRealtimeReport

Permintaan HTTP
Parameter lokasi
Isi permintaan
- Representasi JSON
Isi respons
- Representasi JSON
Cakupan otorisasi
MinuteRange
- Representasi JSON
Cobalah!

Menampilkan laporan kustom data peristiwa realtime untuk properti Anda. Peristiwa muncul di laporan real-time beberapa detik setelah dikirim ke Google Analytics. Laporan Real-Time menampilkan peristiwa dan data penggunaan untuk periode waktu mulai dari 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 Real-Time.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter

Parameter
`property`	`string` ID properti GA4 Google Analytics yang peristiwanya dilacak. Ditentukan di jalur URL, bukan di bagian isi. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti Anda. Contoh: properties/1234

property

string

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

Contoh: properties/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON

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`) } ] }

{
  "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 klausa SQL. Dimensi tidak dapat digunakan dalam filter ini.
`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.
`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.
`returnPropertyQuota`	`boolean` Mengalihkan apakah akan menampilkan status saat ini dari kuota Realtime Properti Analytics ini. Kuota ditampilkan di PropertyQuota.
`minuteRanges[]`	`object (MinuteRange)` Rentang menit data peristiwa yang akan 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 dimasukkan ke dalam baris respons untuk kedua rentang menit tersebut.

Isi respons

Tabel laporan real-time respons yang sesuai dengan permintaan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON

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 }

{
  "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)` Mendeskripsikan kolom dimensi. Jumlah DimensionHeader dan urutan DimensionHeader cocok dengan dimensi yang ada dalam baris.
`metricHeaders[]`	`object (MetricHeader)` Menjelaskan kolom metrik. Jumlah MetricHeader dan urutan MetricHeader cocok dengan metrik yang ada dalam baris.
`rows[]`	`object (Row)` Baris kombinasi nilai dimensi dan nilai metrik dalam laporan.
`totals[]`	`object (Row)` Total nilai metrik jika diminta.
`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` dari 50 dalam permintaan API, responsnya akan berisi `rowCount` dari 175 baris, tetapi hanya 50 baris.
`propertyQuota`	`object (PropertyQuota)` Status kuota Realtime Properti Analytics ini termasuk permintaan ini.
`kind`	`string` Mengidentifikasi jenis resource pesan ini. `kind` ini selalu berupa string tetap "analyticsData#runRealtimeReport". Berguna untuk membedakan berbagai jenis respons di JSON.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

MinuteRange

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

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

Kolom

Kolom
`name`	`string` Menetapkan nama untuk rentang menit ini. Dimensi `dateRange` dinilai untuk nama ini dalam respons laporan. Jika ditetapkan, tidak boleh diawali dengan `date_range_` atau `RESERVED_`. Jika tidak ditetapkan, rentang menit akan diberi nama berdasarkan indeks berbasis nol dalam permintaan: `date_range_0`, `date_range_1`, dll.
`startMinutesAgo`	`integer` Menit mulai inklusif untuk kueri sebagai jumlah menit sebelum sekarang. Misalnya, `"startMinutesAgo": 29` menentukan bahwa laporan harus menyertakan data peristiwa dari 29 menit yang lalu dan setelahnya. Tidak boleh setelah `endMinutesAgo`. Jika tidak ditentukan, `startMinutesAgo` ditetapkan secara default ke 29. Properti Analytics standar dapat meminta data peristiwa hingga 30 menit terakhir (`startMinutesAgo <= 29`), dan properti Analytics 360 dapat meminta data peristiwa hingga 60 menit terakhir (`startMinutesAgo <= 59`).
`endMinutesAgo`	`integer` Menit akhir inklusif untuk kueri sebagai jumlah menit sebelum sekarang. Tidak boleh sebelum `startMinutesAgo`. Misalnya, `"endMinutesAgo": 15` menentukan bahwa laporan harus menyertakan data peristiwa dari sebelum 15 menit yang lalu. Jika tidak ditentukan, `endMinutesAgo` ditetapkan secara default ke 0. Properti Analytics standar dapat meminta data peristiwa (`endMinutesAgo <= 29`) setiap menit dalam 30 menit terakhir, dan properti Analytics 360 dapat meminta data peristiwa dalam 60 menit terakhir (`endMinutesAgo <= 59`).

name

string

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

startMinutesAgo

integer

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

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

endMinutesAgo

integer

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

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