Method: properties.batchRunReports

Trả về nhiều báo cáo 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/*}:batchRunReports

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 RunReportRequest 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 (RunReportRequest)
    }
  ]
}
Trường
requests[]

object (RunReportRequest)

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âu trả lờ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 của thông báo. 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 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 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 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 2 phạm vi ngày trùng lặp, thì dữ liệu sự kiện cho 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 không được chỉ định dateRanges này.
dimensionFilter

object (FilterExpression)

Các 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 bài viết Nguyên tắc cơ bản về bộ lọc phương diện để xem ví dụ. 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 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 các phương diện trong bộ lọc này.
offset

string (int64 format)

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 giá trị bù trừ bằng 0; yêu cầu đầu tiên sẽ trả về limit hàng đầu tiên. Yêu cầu thứ hai thiết lập độ lệch thành limit của yêu cầu đầu tiên; yêu cầu thứ hai sẽ trả về limit thứ hai của hàng.

Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang.
limit

string (int64 format)

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

API cũng có thể trả về ít hàng hơn so với 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 nhiều hơn 300 hàng, ngay cả khi bạn đặt limit thành giá trị cao hơn.

Để tìm hiểu thêm về thông số phân trang này, hãy xem nội dung Phân trang.
metricAggregations[]

enum (MetricAggregation)

Tổng hợp các chỉ số. Các giá trị chỉ số được tổng hợp sẽ hiển thị trong những hàng mà giá trị phương diện được đặt thành "RESERVED_(Tổng hợp chỉ số)".
orderBys[]

object (OrderBy)

Chỉ định cách sắp xếp các hàng trong phản hồi.
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 chỉ cần có một trường thông tin so sánh để nhận được cột so sánh trong phản hồi.