Method: properties.runRealtimeReport

Trả về 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. Sự kiện xuất hiện trong báo cáo theo thời gian thực vài giây sau khi chúng được gửi đến Google Analytics. Báo cáo theo thời gian thực cho biết các sự kiện và dữ liệu sử dụng trong các khoảng thời gian từ thời điểm hiện tại đến 30 phút trước (tối đa 60 phút đối với tài sản Google Analytics 360).

Để xem hướng dẫn về cách tạo yêu cầu theo thời gian thực và hiểu câu trả lời, hãy xem bài viết Tạo báo cáo theo thời gian thực.

Yêu cầu HTTP

POST https://analyticsdata.googleapis.com/v1beta/{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)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
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ị.
dimensionFilter

object (FilterExpression)

Mệnh đề bộ lọc của phương diện. 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. Không thể sử dụng phương diện trong bộ lọc này.
limit

string (int64 format)

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

API cũng có thể trả về ít hàng hơn limit được yêu cầu nếu không có nhiều giá trị phương diện như limit. Ví dụ: có thể có ít hơn 300 giá trị cho phương diện country, vì vậy, khi chỉ báo cáo về country, bạn không thể nhận được nhiều hơn 300 hàng, ngay cả khi đặt limit thành giá trị cao hơn.
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.
minuteRanges[]

object (MinuteRange)

Phạm vi phút của dữ liệu sự kiện cần đọc. Nếu bạn chưa chỉ định thì phạm vi 1 phút trong 30 phút cuối sẽ được sử dụng. Nếu bạn yêu cầu nhiều phạm vi phút, thì mỗi hàng phản hồi sẽ chứa một chỉ mục phạm vi phút dựa trên 0. Nếu phạm vi 2 phút trùng lặp, dữ liệu sự kiện của những phút bị trùng lặp sẽ được đưa vào các hàng phản hồi cho cả hai phạm vi phút.

Nội dung phản hồi

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.

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:

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)
  },
  "kind": string
}
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. rowCount độc lập với số hàng được trả về trong phản hồi và tham số yêu cầu limit. Ví dụ: nếu một truy vấn trả về 175 hàng và bao gồm limit/50 trong yêu cầu API, thì phản hồi sẽ chứa rowCount trong số 175 hàng 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.
kind

string

Xác định loại tài nguyên của thông báo này. kind này luôn là chuỗi cố định "analyticsData#runRealtimeReport". Hữu ích để phân biệt các loại phản hồi trong JSON.

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

MinuteRange

Một nhóm phút liền nhau: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Yêu cầu có thể kéo dài tối đa 2 phút.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Trường
name

string

Gán tên cho phạm vi phút này. Phương diện dateRange được đánh giá bằng tên này trong phản hồi báo cáo. Nếu được đặt thì không được bắt đầu bằng date_range_ hoặc RESERVED_. Nếu bạn không đặt chính sách này, thì các phạm vi phút sẽ được đặt tên theo chỉ mục dựa trên 0 trong yêu cầu: date_range_0, date_range_1, v.v.
startMinutesAgo

integer

Phút bắt đầu bao gồm cho truy vấn dưới dạng số phút trước thời điểm hiện tại. Ví dụ: "startMinutesAgo": 29 chỉ định báo cáo phải bao gồm dữ liệu sự kiện từ 29 phút trước và sau đó. Không được sau endMinutesAgo.

Nếu không chỉ định, startMinutesAgo sẽ được đặt mặc định là 29. Tài sản Analytics chuẩn có thể yêu cầu dữ liệu sự kiện trong tối đa 30 phút vừa qua (startMinutesAgo <= 29), còn tài sản Analytics 360 có thể yêu cầu dữ liệu sự kiện trong tối đa 60 phút vừa qua (startMinutesAgo <= 59).
endMinutesAgo

integer

Phút kết thúc bao gồm cho truy vấn dưới dạng số phút trước thời điểm này. Không được trước startMinutesAgo. Ví dụ: "endMinutesAgo": 15 chỉ định rằng báo cáo phải bao gồm dữ liệu sự kiện xảy ra trước 15 phút trước.

Nếu không chỉ định thì endMinutesAgo được đặt mặc định là 0. Tài sản Analytics chuẩn có thể yêu cầu dữ liệu sự kiện bất kỳ phút nào trong 30 phút qua (endMinutesAgo <= 29) và tài sản Analytics 360 có thể yêu cầu dữ liệu sự kiện bất kỳ phút nào trong 60 phút vừa qua (endMinutesAgo <= 59).