Method: properties.batchRunPivotReports

Trả về nhiều báo cáo tổng hợp theo nhóm. Tất cả báo cáo phải thuộc cùng một tài sản Google Analytics.

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

Mã nhận dạng tài sản 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 phần nội dung. Để tìm hiểu thêm, hãy xem bài viết nơi tìm mã tài sản. Bạn phải chỉ định thuộc tính này cho lô. Thuộc tính trong RunPivotReportRequest có thể không được chỉ định hoặc nhất quán với thuộc tính này.

Ví dụ: properties/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 báo cáo tổng hợp riêng. 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.
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:

  • 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

Mã nhận dạng tài sản 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 phần nội dung. Để tìm hiểu thêm, hãy xem bài viết nơi tìm mã tài sản. Trong một yêu cầu hàng loạt, thuộc tính này phải không được chỉ định hoặc nhất quán với thuộc tính cấp lô.

Ví dụ: properties/1234
dimensions[]

object (Dimension)

Các phương diện được yêu cầu. Tất cả phương diện đã xác định phải được sử dụng bằng một trong các phương thức sau: dimensionExpression, dimensionFilter, pivots, orderBys.
metrics[]

object (Metric)

Các chỉ số được yêu cầu, ít nhất phải chỉ định một chỉ số. Tất cả chỉ số được 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ì dữ liệu sự kiện từ mỗi phạm vi ngày sẽ được sử dụng trong báo cáo. Bạn có thể đưa một phương diện đặc biệt có tên trường "dateRange" 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 về nhóm thuần tập, bạn không được chỉ định dateRanges này.
pivots[]

object (Pivot)

Mô tả định dạng hình ảnh của các phương diện của báo cáo theo cột hoặc hàng. Tập hợp hợp nhất của 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ủ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ể chia sẻ một phương diện. Một phương diện chỉ hiển thị nếu phương diện đó xuất hiện trong một báo cáo 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 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ố. Áp dụng ở giai đoạn sau khi tổng hợp, tương tự như mệnh đề having trong SQL. Bạn phải yêu cầu sử dụng các chỉ số trong bộ lọc này. Bạn 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ó nhóm thuần tập trong yêu cầu, thì bạn phải có phương diện "nhóm thuần tập".
keepEmptyRows

boolean

Nếu giá trị là false hoặc không xác định, thì hệ thống sẽ không trả về mỗi hàng có tất cả chỉ số bằng 0. Nếu đúng, các hàng này sẽ được trả về nếu không bị một bộ lọc xoá riêng.

Bất kể chế độ cài đặt keepEmptyRows này, chỉ dữ liệu do tài sản Google Analytics 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 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 tuỳ chọn trả về trạng thái hiện tại của hạn mức của tài sản Google 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à hiển thị. Yêu cầu này yêu cầu cả trường so sánh và phương diện so sánh để nhận cột so sánh trong phản hồi.