REST Resource: properties.calculatedMetrics

Tài nguyên: CalculatedMetric

Định nghĩa cho một chỉ số được tính.

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

Chỉ có đầu ra. Tên tài nguyên cho CalculatedMetric này. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

Không bắt buộc. Nội dung mô tả cho chỉ số được tính 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ư hiển thị trong giao diện người dùng Google Analytics. Độ dài tối đa 82 ký tự.

calculatedMetricId

string

Chỉ có đầu ra. Mã nhận dạng để sử dụng cho chỉ số được tính toán. Trong giao diện người dùng, đây được gọi là "tên API".

calculatedMetricId được dùng khi tham chiếu đến 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 của giá trị 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. Số lượng tối đa các chỉ số tuỳ chỉnh được tham chiếu riêng biệt là 5. Công thức hỗ trợ các phép toán sau: + (cộng), - (trừ), - (âm), * (nhân), / (chia), () (dấu ngoặc đơn). Mọi số thực hợp lệ đều được chấp nhận, miễn là số đó vừa với Long (số nguyên 64 bit) hoặc Double (số dấu phẩy động 64 bit). Công thức mẫu: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

Chỉ có đầu ra. Nếu giá trị là true, thì chỉ số được tính này có tham chiếu chỉ số không hợp lệ. Mọi nội dung 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 cảnh báo hoặc tạo kết quả không mong muốn.

MetricUnit

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

Enum
METRIC_UNIT_UNSPECIFIED MetricUnit không được chỉ định hoặc bị thiếu.
STANDARD Chỉ số này sử dụng đơ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 lường chiều cao tính bằng feet.
MILES Chỉ số này đo lường số dặm.
METERS Chỉ số này đo lường số mét.
KILOMETERS Chỉ số này đo lường số kilômét.
MILLISECONDS Chỉ số này đo lường mili giây.
SECONDS Chỉ số này đo lường số giây.
MINUTES Chỉ số này đo lường số phút.
HOURS Chỉ số này đo lường số giờ.

RestrictedMetricType

Nhãn đánh dấu dữ liệu trong chỉ số được tính toán, được sử dụng cùng với các vai trò của người dùng hạn chế quyền truy cập vào chỉ số 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 Chỉ số báo cáo 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

Truy vấn một CalculatedMetric.

list

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

patch

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