REST Resource: properties.calculatedMetrics

Tài nguyên: CalculatedMetric

Định nghĩa về chỉ số được tính toán.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên cho CalculatedMetric này. Định dạng: "properties/{property_id}/calculatedMetrics/{calculatedMetricId}"

description

string

Không bắt buộc. Nội dung mô tả cho chỉ số được tính toán này. Độ dài tối đa là 4096 ký tự.

displayName

string

Bắt buộc. Tên hiển thị của chỉ số được tính toán này như xuất hiện trong giao diện người dùng Google Analytics. Độ dài tối đa là 82 ký tự.

calculatedMetricId

string

Chỉ có đầu ra. Giá trị nhận dạng cần dùng cho chỉ số được tính toán. Trong giao diện người dùng, thông tin này được gọi là "Tên API".

calculatedMetricId được dùng khi tham chiếu chỉ số được tính toán này từ các API bên ngoài. Ví dụ: "calcMetric:{calculatedMetricId}".

metricUnit

enum (MetricUnit)

Bắt buộc. Loại giá trị của chỉ số được tính.

restrictedMetricType[]

enum (RestrictedMetricType)

Chỉ có đầu ra. Các loại dữ liệu bị hạn chế mà chỉ số này chứa.

formula

string

Bắt buộc. Định nghĩa của chỉ số được tính toán. Số lượng tối đa các chỉ số tuỳ chỉnh được tham chiếu duy nhất là 5. Công thức hỗ trợ các phép toán sau: + (cộng), – (trừ), – (số âm), * (nhân), / (chia), () (dấu ngoặc đơn). Mọi số thực hợp lệ đều được chấp nhận, phù hợp với số nguyên Long (64 bit) hoặc số có dấu phẩy động Double (64 bit). Công thức ví dụ: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

Chỉ có đầu ra. Nếu đúng, chỉ số được tính toán này có một chỉ số tham chiếu không hợp lệ. Mọi thứ sử dụng chỉ số được tính toán với invalidMetricReference được đặt thành true đều có thể không thành công, tạo ra cảnh báo hoặc tạo ra kết quả không mong muốn.

MetricUnit

Các loại có thể biểu thị giá trị của chỉ số được tính.

Enum
METRIC_UNIT_UNSPECIFIED MetricUnit không được chỉ định hoặc bị thiếu.
STANDARD Chỉ số này sử dụng các đơn vị mặc định.
CURRENCY Chỉ số này đo lường một đơn vị tiền tệ.
FEET Chỉ số này đo bằng feet.
MILES Chỉ số này đo lường bằng dặm.
METERS Chỉ số này đo bằng mét.
KILOMETERS Chỉ số này đo bằng kilômét.
MILLISECONDS Chỉ số này đo lường bằng mili giây.
SECONDS Chỉ số này đo lường bằng giây.
MINUTES Chỉ số này đo lường bằng phút.
HOURS Chỉ số này đo lường theo giờ.

RestrictedMetricType

Nhãn đánh dấu dữ liệu trong chỉ số được tính toán được dùng cùng với vai trò của người dùng để hạn chế quyền truy cập vào chỉ số về chi phí và/hoặc doanh thu.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Loại không xác định hoặc chưa chỉ định.
COST_DATA Chỉ số báo cáo dữ liệu chi phí.
REVENUE_DATA Báo cáo chỉ số về dữ liệu doanh thu.

Phương thức

create

Tạo một CalculatedMetric.

delete

Xoá một CalculatedMetric trên một tài sản.

get

Tra cứu một CalculatedMetric duy nhất.

list

Liệt kê CalculatedMetrics trên một tài sản.

patch

Cập nhật một CalculatedMetric trên một tài sản.