Method: properties.runRealtimeReport

API thời gian thực của Google Analytics sẽ trả về báo cáo tuỳ chỉnh chứa dữ liệu sự kiện theo thời gian thực cho tài sản của bạn. Những báo cáo này cho biết số sự kiện và mức 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 trong nội dung. Để tìm hiểu thêm, hãy xem cách tìm mã tài sản của bạ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 đã yêu cầu và được hiển thị.
metrics[]

object (Metric)

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

string (int64 format)

Số hàng cần trả về. Nếu không chỉ định tham số limit, hàm sẽ trả về 10.000 hàng. API 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. Phải yêu cầu phương diện thì mới có thể sử dụng được 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 trong giai đoạn sau khi tổng hợp, tương tự như mệnh đề của SQL. Bạn phải yêu cầu chỉ số để sử dụng trong bộ lọc này. Không thể sử dụng 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ố tổng hợp sẽ hiển thị trong các hàng mà parameterValues được đặt thành "RESERVED_(Metric tổ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 cho phép 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 theo thời gian thực của phản hồi 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 khía cạnh tiêu đề và thứ tự của các tiêu đề kích thước 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 MetricsHeader và thứ tự của MetricsHeaders khớp với chỉ số có trong các hàng.
rows[]

object (Row)

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

object (Row)

Tổng giá trị 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 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 uỷ quyền

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

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