Method: properties.runReport

Trả về một báo cáo tuỳ chỉnh về dữ liệu sự kiện của bạn trê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 mà API trả về là một 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 phân tích chỉ số theo một số tiêu chí chung, chẳng hạn như quốc gia hoặc tên sự kiện.

Yêu cầu HTTP

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

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

Tham số đường dẫn

Tham số
property

string

Bắt buộc. 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 mã tài sản. Trong một yêu cầu hàng loạt, bạn không nên chỉ định thuộc tính này hoặc phải chỉ định nhất quán với thuộc tính ở cấp lô.

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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Trường
dimensions[]

object (Dimension)

Không bắt buộc. Phương diện được yêu cầu và hiển thị.
metrics[]

object (Metric)

Không bắt buộc. Các chỉ số được yêu cầu và hiển thị.
dateRanges[]

object (DateRange)

Không bắt buộc. Phạm vi ngày của dữ liệu cần đọc. Nếu bạn yêu cầu nhiều dải ngày, mỗi hàng phản hồi sẽ chứa một chỉ mục dải ngày dựa trên số 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 về nhóm, bạn không được chỉ định dateRanges này.
dimensionFilter

object (FilterExpression)

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

object (FilterExpression)

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

string (int64 format)

Không bắt buộc. 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 thứ hai của các hàng.

Để 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)

Không bắt buộc. Số lượng hàng tối đa cần trả về. Nếu bạn không chỉ định, 10.000 hàng sẽ được trả về. API này 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ụ: phương diện country có ít hơn 300 giá trị có thể có, vì vậy, khi chỉ báo cáo về country, bạn không thể nhận được 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)

Không bắt buộc. Tổng hợp các chỉ số. Các giá trị chỉ số được tổng hợp sẽ xuất hiện trong những hàng có 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 các phạm vi ngày.
orderBys[]

object (OrderBy)

Không bắt buộc. 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 lệnh sắp xếp được áp dụng cho các so sánh.
currencyCode

string

Không bắt buộc. 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)

Không bắt buộc. Nhóm когорта đượ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ì bạn phải có phương diện "nhóm thuần tập".
keepEmptyRows

boolean

Không bắt buộc. Nếu là false hoặc không được chỉ định, thì mỗi hàng có tất 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 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ó hàng eventName: "purchase" và eventCount: 0.
returnPropertyQuota

boolean

Không bắt buộc. Chuyển đổi để 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 này chỉ cần một trường so sánh để nhận được một cột so sánh trong phản hồi.
conversionSpec

object (ConversionSpec)

Không bắt buộc. Kiểm soát báo cáo lượt chuyển đổi. Đây là trường không bắt buộc. Nếu bạn đặt trường này hoặc yêu cầu bất kỳ chỉ số lượt chuyển đổi nào, thì báo cáo sẽ là báo cáo lượt chuyển đổi.

Nội dung phản hồi

Bảng báo cáo phản hồi tương ứng với một yêu cầu.

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 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Trường
dimensionHeaders[]

object (DimensionHeader)

Mô tả các cột phương diện. Số lượng DimensionHeader và thứ tự của DimensionHeader khớp với các phương diện có trong hàng.
metricHeaders[]

object (MetricHeader)

Mô tả các cột chỉ số. Số lượng MetricHeader và thứ tự của MetricHeader khớp với các chỉ số có trong hàng.
rows[]

object (Row)

Các hàng gồm tổ hợp giá trị thứ nguyên và giá trị chỉ số trong báo cáo.
totals[]

object (Row)

Nếu được yêu cầu, tổng giá trị của các chỉ số.
maximums[]

object (Row)

Nếu được yêu cầu, giá trị tối đa của các chỉ số.
minimums[]

object (Row)

Nếu được yêu cầu, giá trị tối thiểu của các chỉ số.
rowCount

integer

Tổng số hàng trong kết quả truy vấn, bất kể số hàng được trả về trong phản hồi. Ví dụ: nếu một truy vấn trả về 175 hàng và có limit = 50 trong yêu cầu API, thì phản hồi sẽ chứa rowCount = 175 nhưng chỉ có 50 hàng.

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

object (ResponseMetaData)

Siêu dữ liệu cho báo cáo.
propertyQuota

object (PropertyQuota)

Trạng thái hạn mức của Tài sản Analytics này, bao gồm cả yêu cầu này.
kind

string

Xác định loại tài nguyên của thông báo này. kind này luôn là chuỗi cố định "analyticsData#runReport". Hữu ích để phân biệt các loại phản hồi trong JSON.
nextPageToken

string

Một mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

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

Thông tin so sánh

Xác định một phép so sánh riêng lẻ. Hầu hết các yêu cầu sẽ bao gồm nhiều phép so sánh để báo cáo so sánh giữa các phép so sánh.

Biểu diễn dưới dạng JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Trường
name

string

Mỗi phép so sánh sẽ tạo ra các hàng riêng biệt trong phản hồi. Trong phản hồi, phép so sánh này được xác định bằng tên này. Nếu bạn không chỉ định tên, chúng tôi sẽ sử dụng tên hiển thị của các so sánh đã lưu.

Trường nhóm one_comparison.

one_comparison chỉ có thể là một trong những trạng thái sau:
dimensionFilter

object (FilterExpression)

So sánh cơ bản.
comparison

string

Một phép so sánh đã lưu được xác định bằng tên tài nguyên của phép so sánh. Ví dụ: "comparisons/1234".

ConversionSpec

Kiểm soát báo cáo lượt chuyển đổi.

Biểu diễn dưới dạng JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Trường
conversionActions[]

string

Mã hành động chuyển đổi cần đưa vào báo cáo. Nếu bạn để trống, tất cả lượt chuyển đổi sẽ được đưa vào. Bạn có thể truy xuất mã hành động chuyển đổi hợp lệ từ trường conversionAction trong danh sách conversions trong phản hồi của phương thức properties.getMetadata. Ví dụ: "conversionActions/1234".
attributionModel

enum (AttributionModel)

Mô hình phân bổ cần sử dụng trong Báo cáo lượt chuyển đổi. Nếu bạn không chỉ định, hệ thống sẽ sử dụng DATA_DRIVEN.

AttributionModel

Mô hình phân bổ để sử dụng trong Báo cáo lượt chuyển đổi

Enum
ATTRIBUTION_MODEL_UNSPECIFIED Mô hình phân bổ chưa được chỉ định.
DATA_DRIVEN Mô hình phân bổ dựa trên dữ liệu trên kênh có tính phí và kênh tự nhiên
LAST_CLICK Mô hình phân bổ dựa trên lượt nhấp cuối cùng trên kênh tự nhiên và kênh có tính phí