Method: properties.runRealtimeReport

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. Sự kiện xuất hiện trong báo cáo theo thời gian thực vài giây sau khi được gửi đến Google Analytics. Báo cáo theo thời gian thực cho thấy các sự kiện và dữ liệu sử dụng trong 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).

Để biết hướng dẫn về cách tạo yêu cầu theo thời gian thực và hiểu các phản hồ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

Mã nhận dạng tài sản 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 phần nội dung. Để tìm hiểu thêm, hãy xem bài viết nơi tìm mã tài sản.

Ví dụ: properties/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 được yêu cầu và 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ố. Áp dụng ở giai đoạn sau khi tổng hợp, tương tự như mệnh đề having trong SQL. Bạn không thể sử dụng phương diện trong bộ lọc này.
limit

string (int64 format)

Số lượng hàng sẽ trả về. Nếu không chỉ định, hệ thống sẽ trả về 10.000 hàng. API sẽ 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ó ít hơn 300 giá trị có thể có 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 bạn đặt limit thành một 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ẽ xuất hiện trong các hàng có dimensionValues được đặt thành "RESERVED_(MetricAggregation)".
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 tuỳ chọn 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 Google 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 không chỉ định, hệ thống sẽ sử dụng phạm vi một phút trong 30 phút gần nhất. 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 hai phạm vi phút trùng lặp, thì dữ liệu sự kiện cho các phút 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 phản hồi theo thời gian thực 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 DimensionHeader và thứ tự của DimensionHeader khớp với các phương diện có trong hàng.
metricHeaders[]

object (MetricHeader)

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

object (Row)

Các hàng 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 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. 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 gồm 50 hàng trong yêu cầu API, thì phản hồi sẽ chứa rowCount gồm 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 Google 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:

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

MinuteRange

Một tập hợp các phút liền kề: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Yêu cầu được phép có phạm vi tối đa là 2 phút.

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

string

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

integer

Số phút bắt đầu của truy vấn, tính cả phút 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 trở đi. Không được sau endMinutesAgo.

Nếu không chỉ định, startMinutesAgo sẽ 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 gần nhất (startMinutesAgo <= 29) và 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 gần nhất (startMinutesAgo <= 59).
endMinutesAgo

integer

Số phút kết thúc của truy vấn, tính cả số phút trước thời điểm hiện tại. Không được trước startMinutesAgo. Ví dụ: "endMinutesAgo": 15 chỉ định báo cáo phải bao gồm dữ liệu sự kiện từ trước 15 phút.

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