Method: properties.runRealtimeReport

API thời gian thực của Google Analytics trả về một báo cáo tuỳ chỉnh về dữ liệu sự kiện theo thời gian thực cho tài sản của bạn. Các báo cáo này cho biết các sự kiện và hoạt động sử dụng trong 30 phút vừa qua.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
property

string

Giá trị nhận dạng tài sản GA4 của Google Analytics có các sự kiện được theo dõi. Được chỉ định trong đường dẫn URL chứ không phải nội dung. Để tìm hiểu thêm, hãy xem nơi xem Mã tài sản.

Ví dụ: thuộc tính/1234

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Trường
dimensions[]

object (Dimension)

Các phương diện được yêu cầu và hiển thị.
metrics[]

object (Metric)

Các chỉ số được yêu cầu và được hiển thị.
limit

string (int64 format)

Số hàng cần trả về. Nếu tham số limit không được chỉ định, hệ thống sẽ trả về 10.000 hàng. API sẽ trả về tối đa 100.000 hàng cho mỗi yêu cầu, bất kể bạn yêu cầu bao nhiêu hàng.
dimensionFilter

object (FilterExpression)

Mệnh đề bộ lọc của phương diện. Bạn phải yêu cầu các phương diện để sử dụng trong bộ lọc này. Không thể sử dụng chỉ số trong bộ lọc này.
metricFilter

object (FilterExpression)

Mệnh đề bộ lọc của chỉ số. Được áp dụng ở giai đoạn sau khi tổng hợp, tương tự như mệnh đề SQL. Bạn phải yêu cầu các chỉ số để sử dụng trong bộ lọc này. Không thể sử dụng các phương diện trong bộ lọc này.
metricAggregations[]

enum (MetricAggregation)

Tổng hợp các chỉ số. Các giá trị chỉ số được tổng hợp sẽ hiển thị trong những hàng mà giá trị tham số được đặt thành "RESERVED_(MetricTổng hợp)".
orderBys[]

object (OrderBy)

Chỉ định cách sắp xếp các hàng trong phản hồi.
returnPropertyQuota

boolean

Bật/tắt tính năng trả về trạng thái hiện tại của hạn mức theo thời gian thực của Tài sản Analytics này. Hạn mức được trả về trong PropertyQuota.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Bảng báo cáo phản hồi theo thời gian thực tương ứng với một yêu cầu.

Biểu diễn dưới dạng JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
Trường
dimensionHeaders[]

object (DimensionHeader)

Mô tả các cột phương diện. Số lượng Kích thước và thứ tự của tham số này khớp với các phương diện có trong các hàng.
metricHeaders[]

object (MetricHeader)

Mô tả các cột chỉ số. Số lượng metricHeaders và thứ tự của MetricsHeaders khớp với các chỉ số có trong các hàng.
rows[]

object (Row)

Các hàng gồm các tổ hợp giá trị phương diện và giá trị chỉ số trong báo cáo.
totals[]

object (Row)

Đây là giá trị tổng của các chỉ số (nếu được yêu cầu).
maximums[]

object (Row)

Giá trị tối đa của các chỉ số (nếu được yêu cầu).
minimums[]

object (Row)

Giá trị tối thiểu của các chỉ số (nếu được yêu cầu).
rowCount

integer

Tổng số hàng trong kết quả truy vấn, bất kể số lượng hàng được trả về trong phản hồi. Ví dụ: nếu truy vấn trả về 175 hàng và bao gồm giới hạn = 50 trong yêu cầu API, thì phản hồi sẽ chứa hàngCount = 175 nhưng chỉ có 50 hàng.
propertyQuota

object (PropertyQuota)

Trạng thái hạn mức theo thời gian thực của Tài sản Analytics này, bao gồm cả yêu cầu này.

Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

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