Method: properties.batchRunPivotReports

Trả về nhiều báo cáo tổng hợp 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/*}:batchRunPivotReports

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
property

string

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 RunPivotReportRequest có thể chưa được chỉ định hoặc nhất quán 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 (RunPivotReportRequest)
    }
  ]
}
Trường
requests[]

object (RunPivotReportRequest)

Yêu cầu riêng lẻ. Mỗi yêu cầu có một phản hồi riêng cho báo cáo tổng hợp. 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 tổng hợp.

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 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Trường
pivotReports[]

object (RunPivotReportResponse)

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 tổng hợp riêng.
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#batchRunPivotReports". 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 đây:

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

RunPivotReportRequest

Yêu cầu tạo báo cáo tổng hợp.

Biểu diễn dưới dạng JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "pivots": [
    {
      object (Pivot)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Trường
property

string

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[]

object (Dimension)

Các phương diện được yêu cầu. Tất cả các phương diện đã xác định phải được sử dụng bởi một trong các thuộc tính sau: kích thước thực hiện, bộ lọc kích thước, xoay quanh các thứ nguyên, orderBys.
metrics[]

object (Metric)

Các chỉ số đã yêu cầu, cần phải chỉ định ít nhất một chỉ số. Tất cả chỉ số đã xác định phải được sử dụng theo một trong các thuộc tính sau: biểu_thức_chỉ_mục, bộ lọc chỉ số, bộ lọc thứ_ tự.
dateRanges[]

object (DateRange)

Phạm vi ngày để truy xuất dữ liệu sự kiện cho báo cáo. Nếu bạn chỉ định nhiều phạm vi ngày, thì dữ liệu sự kiện trong mỗi phạm vi ngày sẽ được sử dụng trong báo cáo. Có thể bao gồm thứ nguyên đặc biệt có tên trường "dateRange" trong tên trường của Pivot; nếu được đưa vào, báo cáo sẽ so sánh giữa các phạm vi ngày. Trong yêu cầu nhóm thuần tập, bạn phải chỉ định dateRanges này.
pivots[]

object (Pivot)

Mô tả định dạng trực quan của các phương diện báo cáo trong cột hoặc hàng. Hợp nhất các fieldNames (tên phương diện) trong tất cả các bảng tổng hợp phải là một tập hợp con các tên phương diện được xác định trong Phương diện. Không có hai bảng tổng hợp nào có thể chia sẻ một phương diện. Một phương diện chỉ hiển thị khi xuất hiện trong bảng tổng hợp.
dimensionFilter

object (FilterExpression)

Mệnh đề bộ lọc của phương diện. Phải yêu cầu phương diện thì mới có thể sử dụng được trong bộ lọc này. 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ố. Được áp dụng trong giai đoạn sau khi tổng hợp, tương tự như mệnh đề của SQL. Bạn phải yêu cầu chỉ số để sử dụng trong bộ lọc này. Không thể sử dụng phương diện trong bộ lọc này.
currencyCode

string

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

object (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

boolean

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 keepEmptyRows này là gì, chỉ những dữ liệu do tài sản Google Analytics (GA4) ghi lại mới có thể hiển thị trong báo cáo.

Ví dụ: nếu một tài sản không ghi nhận sự kiện purchase, thì truy vấn cho phương diện eventName và chỉ số eventCount sẽ không có eventName: "purchase" và eventCount: 0.
returnPropertyQuota

boolean

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.