- 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
- RunReportRequest
- Hãy làm thử!
Trả về nhiều báo cáo trong một loạt. Tất cả báo cáo đều phải cho cùng một Tài sản GA4.
Yêu cầu HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Thông 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. Bạn phải chỉ định thuộc tính này cho lô. Thuộc tính trong RunReportRequest có thể chưa được chỉ định hoặc phù hợp với thuộc tính này. 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 |
---|
{
"requests": [
{
object ( |
Trường | |
---|---|
requests[] |
Yêu cầu riêng lẻ. Mỗi yêu cầu có một phản hồi báo cáo riêng. Mỗi yêu cầu theo lô được phép có tối đa 5 yêu cầu. |
Nội dung phản hồi
Phản hồi hàng loạt chứa nhiều báo cáo.
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 |
---|
{
"reports": [
{
object ( |
Trường | |
---|---|
reports[] |
Câu trả lời của từng người. Mỗi phản hồi có một yêu cầu báo cáo riêng. |
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
RunReportRequest
Yêu cầu tạo báo cáo.
Biểu diễn dưới dạng JSON |
---|
{ "property": string, "dimensions": [ { object ( |
Trường | |
---|---|
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. Trong một yêu cầu theo lô, tài sản này cần phải đượ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 |
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ị. |
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 của 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 phải chỉ định |
dimensionFilter |
Bộ lọc phương diện chỉ cho phép bạn yêu cầu một số giá trị phương diện cụ thể trong báo cáo. Để tìm hiểu thêm, hãy xem Nguyên tắc cơ bản về bộ lọc phương diện để biết 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 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 độ lệch bằng 0; yêu cầu đầu tiên trả về Để tìm hiểu thêm về thông số phân trang này, hãy xem phần Phân trang. |
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 Để tìm hiểu thêm về thông số phân trang này, hãy xem phần Phân trang. |
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. |
currencyCode |
Mã đơn vị tiền tệ theo đị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 nhóm thuần tập trong yêu cầu, thì bạn phải cung cấp phương diện "nhóm thuần tập". |
keepEmptyRows |
Nếu sai hoặc không chỉ định thì mỗi hàng có tất cả các chỉ số bằng 0 sẽ không được trả về. Nếu đúng, các hàng này sẽ được trả về nếu chúng không bị bộ lọc xoá riêng. Bất kể chế độ cài đặt Ví dụ: nếu một tài sản không ghi nhận 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 của 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 phép so sánh được yêu cầu và hiển thị. Yêu cầu này chỉ yêu cầu trường so sánh để nhận cột so sánh trong phản hồi. |