- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- MinuteRange
- Hãy làm thử!
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 |
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 ( |
Trường | |
---|---|
dimensions[] |
Các phương diện đã yêu cầu và được hiển thị. |
metrics[] |
Các chỉ số được yêu cầu và hiển thị. |
dimensionFilter |
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 |
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 |
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. API cũng có thể trả về ít hàng hơn |
metricAggregations[] |
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[] |
Chỉ định cách sắp xếp các hàng trong phản hồi. |
returnPropertyQuota |
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[] |
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 ( |
Trường | |
---|---|
dimensionHeaders[] |
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[] |
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[] |
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[] |
Tổng giá trị của các chỉ số, nếu được yêu cầu. |
maximums[] |
Giá trị tối đa của các chỉ số nếu được yêu cầu. |
minimums[] |
Giá trị tối thiểu của chỉ số nếu được yêu cầu. |
rowCount |
Tổng số hàng trong kết quả truy vấn. |
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 |
Xác định loại tài nguyên của thông báo 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
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 |
Gán tên cho phạm vi phút này. Phương diện |
startMinutesAgo |
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ụ: Nếu không chỉ định, |
endMinutesAgo |
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 Nếu không chỉ định thì |