Trả về báo cáo tuỳ chỉnh về dữ liệu sự kiện Google Analytics. Báo cáo chứa thống kê bắt nguồn từ dữ liệu được mã theo dõi Google Analytics thu thập. Dữ liệu được API trả về ở dạng bảng có các cột cho phương diện và chỉ số được yêu cầu. Chỉ số là các số liệu đo lường riêng lẻ về hoạt động của người dùng trên tài sản của bạn, chẳng hạn như số người dùng đang hoạt động hoặc số sự kiện. Phương diện phân tích các chỉ số theo một số tiêu chí chung, chẳng hạn như quốc gia hoặc tên sự kiện.
Để được hướng dẫn về cách tạo yêu cầu và hiểu câu trả lời, hãy xem phần Tạo báo cáo.
Yêu cầu HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport
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 nội dung. Để tìm hiểu thêm, hãy xem nơi xem Mã tài sản. Trong yêu cầu theo lô, tài sản này phải không được chỉ định hoặc nhất quán với tài sản cấp lô. 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 được yêu cầu và hiển thị. |
metrics[] |
Các chỉ số được yêu cầu và được hiển thị. |
dateRanges[] |
Phạm vi ngày của dữ liệu cần đọc. Nếu bạn yêu cầu nhiều phạm vi ngày, thì mỗi hàng phản hồi sẽ chứa một chỉ mục phạm vi ngày dựa trên 0. Nếu hai phạm vi ngày trùng lặp, thì dữ liệu sự kiện cho những ngày bị trùng lặp sẽ được đưa vào các hàng phản hồi cho cả hai phạm vi ngày. Trong yêu cầu nhóm thuần tập, bạn không được chỉ định |
dimensionFilter |
Bộ lọc phương diện cho phép bạn chỉ yêu cầu các giá trị phương diện cụ thể trong báo cáo. Để tìm hiểu thêm, hãy xem bài viết Nguyên tắc cơ bản về bộ lọc phương diện để xem ví dụ. 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 sau khi tổng hợp các hàng của báo cáo, tương tự như mệnh đề SQL. Không thể sử dụng các phương diện trong bộ lọc này. |
offset |
Số lượng hàng của hàng bắt đầu. Hàng đầu tiên được tính là hàng 0. Khi phân trang, yêu cầu đầu tiên không chỉ định độ lệch; hoặc tương đương, đặt giá trị bù trừ bằng 0; yêu cầu đầu tiên sẽ trả về Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang. |
limit |
Số hàng cần trả về. Nếu bạn không chỉ định thì 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. API cũng có thể trả về ít hàng hơn so với Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang. |
metricAggregations[] |
Tổng hợp các chỉ số. Các giá trị chỉ số được tổng hợp sẽ hiển thị trong những hàng mà giá trị tham số được đặt thành "RESERVED_(MetricTổng hợp)". |
orderBys[] |
Chỉ định cách sắp xếp các hàng trong phản hồi. |
currencyCode |
Mã đơn vị tiền tệ ở định dạng ISO4217, chẳng hạn như "AED", "USD", "JPY". Nếu trường này trống, báo cáo sẽ sử dụng đơn vị tiền tệ mặc định của tài sản. |
cohortSpec |
Nhóm thuần tập được liên kết với yêu cầu này. Nếu có một nhóm thuần tập trong yêu cầu, thì "nhóm thuần tập" bắt buộc phải có phương diện. |
keepEmptyRows |
Nếu giá trị là false hoặc không được chỉ định, thì hệ thống sẽ không trả về mỗi hàng có tất cả các chỉ số bằng 0. Nếu đúng, các hàng này sẽ được trả về nếu chúng không bị bộ lọc loại bỏ riêng biệt. Bất kể chế độ cài đặt Ví dụ: nếu một tài sản chưa bao giờ ghi lại sự kiện |
returnPropertyQuota |
Bật/tắt tính năng trả về trạng thái hiện tại của hạn mức cho Tài sản Analytics này. Hạn mức được trả về trong PropertyQuota. |
comparisons[] |
Không bắt buộc. Cấu hình của các phép so sánh được yêu cầu và được hiển thị. Yêu cầu chỉ cần có một trường thông tin so sánh để nhận được cột so sánh trong phản hồi. |
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của RunReportResponse
.
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