Method: properties.runReport

Trả về một 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ê được lấy từ dữ liệu do mã theo dõi Google Analytics thu thập. Dữ liệu được trả về từ API ở dạng bảng có các cột cho phương diện và chỉ số được yêu cầu. Chỉ số là các phép đo 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ố sự kiện. Phương diện chia nhỏ các chỉ số theo một số tiêu chí phổ biến, chẳng hạn như quốc gia hoặc tên sự kiện.

Để biết hướng dẫn về cách tạo yêu cầu và hiểu phản hồ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

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 nơi tìm thấy Mã tài sản. Trong 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 hàng loạt.

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 
{
  "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
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 phải không 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 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 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, đặ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 phần 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 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ẽ 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 được áp dụng cho các phép 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 bạn không chỉ định hoặc đặt thành false, thì mỗi hàng có tất cả các chỉ số bằng 0 sẽ không được trả về. Nếu bạn đặt thành 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: "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 phép 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.

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 thực thể của RunReportResponse.

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