REST Resource: properties.customMetrics

Tài nguyên: CustomMetric

Định nghĩa cho 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 của tài nguyên CustomMetric này. Định dạng: thuộc tính/{property}/customMetrics/{customMetric}
parameterName

string

Bắt buộc. Bất biến. 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 các ký tự chữ-số và 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ự cho 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ư được hiển thị trong giao diện người dùng Analytics. Độ dài tối đa là 82 ký tự, gồm cả chữ và số, cộng với 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 sử dụng 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 150 ký tự.
measurementUnit

enum (MeasurementUnit)

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

enum (MetricScope)

Bắt buộc. Bất biến. 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ế có trong chỉ số này. Bắt buộc đối với những chỉ số có đơn vị đo lường CURRENCY. Phải để trống đối với những chỉ số có đơn vị đo lường không phải CURRENCY.

MeasurementUnit

Các loại có thể biểu thị giá trị của chỉ số tùy chỉnh.

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

Enum
MEASUREMENT_UNIT_UNSPECIFIED Đơn vị đo lường 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 lường bộ.
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 dặm.
MILLISECONDS Chỉ số này đo lường bằ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 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 chưa được chỉ định.
EVENT Chỉ số trong phạm vi một sự kiện.

RestrictedMetricType

Các nhãn đánh dấu dữ liệu trong chỉ số tuỳ chỉnh này là dữ liệu nên được giới hạn ở 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 được 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 Chỉ số tuỳ chỉnh.

get

 Tìm một Chỉ số tuỳ chỉnh duy nhất.

list

 Liệt kê CustomMetrics trên một thuộc tính.

patch

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