Method: properties.batchRunPivotReports

Trả về nhiều báo cáo tổng hợp trong một loạt báo cáo. Tất cả báo cáo phải về 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 nội dung. Để tìm hiểu thêm, hãy xem nơi xem Mã tài sản. Thuộc tính này phải được chỉ định 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 hàng loạt đượ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 riêng lẻ. Mỗi phản hồi có một yêu cầu báo cáo tổng hợp riêng biệt.
kind

string

Xác định loại tài nguyên của thông báo. kind này luôn là chuỗi cố định "analyticsData#batchRunPivotReports". 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

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,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
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 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
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 tham số sau: thắng, Kích thước, Trục, OrderBys.
metrics[]

object (Metric)

Chỉ số được yêu cầu, cần phải chỉ định ít nhất một chỉ số. Tất cả các chỉ số đã xác định phải được sử dụng bằng một trong các chỉ số sau: metric_expression, metricFilter, orderBys.
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ì báo cáo sẽ sử dụng dữ liệu sự kiện trong từng phạm vi ngày. Một phương diện đặc biệt có tên trường là "daterange" có thể được đưa vào tên trường của Pivot; nếu có, 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 không được chỉ định dateRanges này.
pivots[]

object (Pivot)

Mô tả định dạng trực quan của các phương diện trong báo cáo theo cột hoặc hàng. Sự hợp nhất của tên phương diện (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ủa 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ể dùng chung một phương diện. Phương diện chỉ hiển thị nếu 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. Bạn phải yêu cầu các phương diện để sử dụng 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 ở giai đoạn sau khi tổng hợp, tương tự như mệnh đề SQL. Bạn phải yêu cầu các chỉ số để sử dụng trong bộ lọc này. Không thể sử dụng các phương diện trong bộ lọc này.
currencyCode

string

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

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

boolean

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 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ể xuất hiện trong báo cáo.

Ví dụ: nếu một tài sản chưa bao giờ ghi lại sự kiện purchase, thì truy vấn cho phương diện eventName và chỉ số eventCount sẽ không có hàng 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 cho Tài sản Analytics này. Hạn mức được trả về trong PropertyQuota.
comparisons[]

object (Comparison)

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 này cần có cả trường phép so sánh và phương diện phép so sánh để nhận được cột so sánh trong phản hồi.