Method: properties.runReport

Trả về báo cáo tuỳ chỉnh về dữ liệu sự kiện Google Analytics. Báo cáo chứa số liệu thống kê bắt nguồn từ dữ liệu do mã theo dõi Google Analytics thu thập. Dữ liệu mà API trả về sẽ ở dạng bảng với các cột cho những phương diện và chỉ số được yêu cầu. Chỉ số là các chỉ số đo lường riêng lẻ về hoạt động của người dùng trên tài sản của bạn, chẳng hạn như số người dùng đang hoạt động hoặc số lượng sự kiện. Phương diện phân tích các chỉ số theo một số tiêu chí phổ biến, chẳng hạn như tên quốc gia hoặc tên sự kiện.

Để được hướng dẫn tạo yêu cầu và tìm hiểu câu trả lời, hãy xem bài viết Tạo báo cáo.

Yêu cầu HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runReport

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

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 
{
  "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
}
Trường
dimensions[]

object (Dimension)

Các phương diện đã yêu cầu và được 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 hai phạm vi ngày trùng lặp, thì dữ liệu sự kiện của 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 phải chỉ định dateRanges này.
dimensionFilter

object (FilterExpression)

Bộ lọc phương diện chỉ cho phép bạn yêu cầu một số giá trị phương diện cụ thể trong báo cáo. Để tìm hiểu thêm, hãy xem Nguyên tắc cơ bản về bộ lọc phương diện để biết 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 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 độ lệch bằng 0; yêu cầu đầu tiên trả về limit đầu tiên của các hàng. Yêu cầu thứ hai đặt độ lệch với limit của yêu cầu đầu tiên; yêu cầu thứ hai trả về limit thứ hai của các hàng.

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

string (int64 format)

Số hàng cần trả về. Nếu không chỉ định, hàm 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 hàng. 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ó thể có ít hơn 300 giá trị 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 đặ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 phần 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ẽ hiển thị trong các hàng mà parameterValues được đặt thành "RESERVED_(Metric tổng hợp)".
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ệ 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.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của RunReportResponse.

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