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

Yêu cầu HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runReport

URL sử dụng cú pháp Chuyển mã gRPC.

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 
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Trường
entity

object (Entity)

Tài sản có sự kiện được theo dõi. Trong một yêu cầu hàng loạt, thực thể này phải được chỉ định hoặc nhất quán với thực thể cấp lô.
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.
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.
limit

string (int64 format)

Số hàng cần trả về. Nếu không chỉ định tham số limit, hàm sẽ trả về 10.000 hàng. API trả về tối đa 100.000 hàng cho mỗi yêu cầu, bất kể bạn yêu cầu bao nhiêu hàng.
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)".
dimensionFilter

object (FilterExpression)

Mệnh đề bộ lọc của phương diện. Phải yêu cầu phương diện thì mới có thể sử dụng được 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ố. Được áp dụng trong giai đoạn sau khi tổng hợp, tương tự như mệnh đề của SQL. Bạn phải yêu cầu chỉ số để sử dụng trong bộ lọc này. Không thể sử dụng phương diện trong bộ lọc này.
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 thực thể.
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.
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