REST Resource: properties.customMetrics

Tài nguyên: CustomMetric

Định nghĩa cho một chỉ số tuỳ chỉnh.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên cho tài nguyên CustomMetric này. Định dạng: properties/{property}/customMetrics/{customMetric}
parameterName

string

Bắt buộc. Không thể thay đổi. Tên gắn thẻ cho chỉ số tuỳ chỉnh này.

Nếu đây là chỉ số ở phạm vi sự kiện, thì đây là tên thông số sự kiện.

Chỉ được chứa ký tự chữ và số, dấu gạch dưới, bắt đầu bằng một chữ cái. Độ dài tối đa là 40 ký tự đối với các chỉ số ở phạm vi sự kiện.
displayName

string

Bắt buộc. Tên hiển thị cho chỉ số tuỳ chỉnh này như hiển thị trong giao diện người dùng Analytics. Độ dài tối đa 82 ký tự, bao gồm chữ và số, dấu cách và dấu gạch dưới, bắt đầu bằng một chữ cái. Tên hiển thị cũ do hệ thống tạo có thể chứa dấu ngoặc vuông, nhưng nội dung cập nhật cho trường này sẽ không bao giờ cho phép dấu ngoặc vuông.
description

string

Không bắt buộc. Nội dung mô tả cho phương diện tuỳ chỉnh này. Độ dài tối đa là 150 ký tự.
measurementUnit

enum (MeasurementUnit)

Bắt buộc. Loại của giá trị chỉ số tuỳ chỉnh.
scope

enum (MetricScope)

Bắt buộc. Không thể thay đổi. Phạm vi của chỉ số tuỳ chỉnh này.
restrictedMetricType[]

enum (RestrictedMetricType)

Không bắt buộc. Các loại dữ liệu bị hạn chế mà chỉ số này có thể chứa. Bắt buộc đối với các chỉ số có đơn vị đo lường là TIỀN TỆ. Phải để trống đối với các chỉ số có đơn vị đo lường không phải là ĐƠN VỊ TIỀN TỆ.

MeasurementUnit

Các loại có thể dùng để biểu thị giá trị của chỉ số tuỳ chỉnh.

Cách trình bày đơn vị tiền tệ có thể thay đổi trong tương lai, đòi hỏi phải thay đổi API có thể gây lỗi.

Enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit 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.
METERS Chỉ số này đo lường số mét.
KILOMETERS Chỉ số này đo lường số kilômét.
MILES Chỉ số này đo lường số dặm.
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ờ.

MetricScope

Phạm vi của chỉ số này.

Enum
METRIC_SCOPE_UNSPECIFIED Phạm vi không xác định hoặc không được chỉ định.
EVENT Chỉ số ở phạm vi sự kiện.

RestrictedMetricType

Nhãn đánh dấu dữ liệu trong chỉ số tuỳ chỉnh này là dữ liệu cần hạn chế đối với một số người dùng cụ thể.

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

archive

 Lưu trữ một CustomMetric trên một tài sản.

create

 Tạo một CustomMetric.

get

 Truy vấn một CustomMetric.

list

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

patch

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