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. Các 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

Thông số
property

string

Giá trị 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 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 với 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 các phương diện. Bạ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 các chỉ số. Được áp dụng ở giai đoạn tổng hợp sau, 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ố hàng sẽ trả về. Nếu bạn không chỉ định, hệ thống 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. 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 mà 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

Chuyển đổi trạng thái có 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 hay không. Hạn mức được trả về trong PropertyQuota.
minuteRanges[]

object (MinuteRange)

Các khoảng thời gian theo 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 một khoảng thời gian theo phút cho 30 phút gần nhất. Nếu bạn yêu cầu nhiều khoảng thời gian theo phút, thì mỗi hàng phản hồi sẽ chứa một chỉ mục khoảng thời gian theo phút dựa trên 0. Nếu 2 khoảng thời gian theo phút trùng nhau, thì dữ liệu sự kiện cho các phút trùng nhau sẽ được đưa vào các hàng phản hồi cho cả 2 khoảng thời gian theo phút.

Nội dung phản hồi

Bảng báo cáo 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 DimensionHeaders và thứ tự của DimensionHeaders 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 MetricHeaders và thứ tự của MetricHeaders khớp với các chỉ số có trong hàng.
rows[]

object (Row)

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

object (Row)

Nếu được yêu cầu, tổng giá trị của các chỉ số.
maximums[]

object (Row)

Nếu được yêu cầu, giá trị tối đa của các chỉ số.
minimums[]

object (Row)

Nếu được yêu cầu, giá trị tối thiểu của các chỉ số.
rowCount

integer

Tổng số hàng trong kết quả truy vấn. rowCount không phụ thuộc vào 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 là 50 trong yêu cầu API, thì phản hồi sẽ chứa rowCount là 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 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 mà thông báo này đại diện. kind này luôn là chuỗi cố định "analyticsData#runRealtimeReport". Hữu ích để phân biệt giữa 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. Bạn có thể yêu cầu tối đa 2 khoảng thời gian theo 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 khoảng thời gian theo phút này. Phương diện dateRange được định giá theo tên này trong phản hồi báo cáo. Nếu được đặt, không thể bắt đầu bằng date_range_ hoặc RESERVED_. Nếu không được đặt, các khoảng thời gian theo 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 cả phút này) 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 rằng 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 thể sau endMinutesAgo.

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

integer

Phút kết thúc (bao gồm cả phút này) cho truy vấn dưới dạng số phút trước thời điểm hiện tại. Không thể 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 từ trước 15 phút.

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