Method: properties.batchRunReports

Trả về nhiều báo cáo trong một lô. Tất cả báo cáo phải dành cho cùng một tài sản Google Analytics.

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

string

Giá trị 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 nội dung. Để tìm hiểu thêm, hãy xem bài viết Tìm mã tài sản. Bạn phải chỉ định tài sản này cho lô. Bạn có thể không chỉ định tài sản trong RunReportRequest hoặc chỉ định tài sản đó nhất quán với tài sản 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 với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Trường
requests[]

object (RunReportRequest)

Các 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 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.

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 (RunReportResponse)
    }
  ],
  "kind": string
}
Trường
reports[]

object (RunReportResponse)

Các phản hồi riêng lẻ. Mỗi phản hồi có một yêu cầu báo cáo riêng.
kind

string

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

RunReportRequest

Yêu cầu tạo báo cáo.

Biểu diễn dưới dạng JSON 
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "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 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 bài viết Tìm mã tài sản. Trong một yêu cầu hàng loạt, bạn có thể không chỉ định tài sản này hoặc chỉ định tài sản đó nhất quán với tài sản ở cấp lô.

Ví dụ: properties/1234
dimensions[]

object (Dimension)

Các phương diện được yêu cầu và hiển thị.
metrics[]

object (Metric)

Các chỉ số được yêu cầu và hiển thị.
dateRanges[]

object (DateRange)

Phạm vi ngày của dữ liệu cần đọc. Nếu yêu cầu nhiều phạm vi ngày, 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 nhau, dữ liệu sự kiện cho những ngày trùng nhau 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 когорта, bạn không được chỉ định dateRanges này.
dimensionFilter

object (FilterExpression)

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 phần Các nguyên tắc cơ bản về bộ lọc phương diện để biết ví dụ. Bạn không thể sử dụng các chỉ số trong bộ lọc này.
metricFilter

object (FilterExpression)

Mệnh đề bộ lọc của các 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 đề having của SQL. Bạn không thể sử dụng các phương diện trong bộ lọc này.
offset

string (int64 format)

Số 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 với việc đặt độ lệch thành 0; yêu cầu đầu tiên trả về limit hàng đầu tiên. Yêu cầu thứ hai đặt độ lệch thành limit của yêu cầu đầu tiên; yêu cầu thứ hai trả về limit hàng thứ hai.

Để tìm hiểu thêm về tham số phân trang này, hãy xem bài viết Phân trang.
limit

string (int64 format)

Số hàng sẽ trả về. Nếu bạn không chỉ định, hệ thống 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. limit phải là số dương.

API cũng có thể trả về ít hàng hơn limit được yêu cầu, nếu không có nhiều giá trị phương diện như limit. Ví dụ: có ít hơn 300 giá trị có thể có cho phương diện country, vì vậy, khi chỉ báo cáo về country, bạn không thể nhận được nhiều hơn 300 hàng, ngay cả khi bạn đặt limit thành một giá trị cao hơn.

Để tìm hiểu thêm về tham số phân trang này, hãy xem bài viết Phân trang.
metricAggregations[]

enum (MetricAggregation)

Tổng hợp các chỉ số. Các giá trị chỉ số tổng hợp sẽ xuất hiện trong các hàng mà dimensionValues được đặt thành "RESERVED_(MetricAggregation)". Các giá trị tổng hợp bao gồm cả so sánh và nhiều phạm vi ngày sẽ được tổng hợp dựa trên phạm vi ngày.
orderBys[]

object (OrderBy)

Chỉ định cách sắp xếp các hàng trong phản hồi. Các yêu cầu bao gồm cả so sánh và nhiều phạm vi ngày sẽ có các giá trị sắp xếp theo được áp dụng cho các giá trị so sánh.
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 когорта liên kết với yêu cầu này. Nếu có một nhóm когорта trong yêu cầu, thì phải có phương diện "когорта".
keepEmptyRows

boolean

Nếu là false hoặc không được 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 là true, thì các hàng này sẽ được trả về nếu không bị 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ể xuất hiện 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ì một truy vấn cho phương diện eventName và chỉ số eventCount sẽ không có một sự kiện hàng eventName: "purchase" và eventCount: 0.
returnPropertyQuota

boolean

Bật/tắt việc trả về trạng thái hiện tại của hạn mức 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 giá trị so sánh được yêu cầu và hiển thị. Yêu cầu chỉ cần một trường so sánh để nhận cột so sánh trong phản hồi.