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

Mã nhận dạng. 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 thay đổi được. Tên gắn thẻ cho chỉ số tuỳ chỉnh này.

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

Chỉ có thể chứa các ký tự chữ và 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ự đố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ư trong giao diện người dùng Analytics. Độ dài tối đa là 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ị do hệ thống cũ tạo có thể chứa dấu ngoặc vuông, nhưng các bản 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 giá trị cho chỉ số tuỳ chỉnh.
scope

enum (MetricScope)

Bắt buộc. Không thay đổi được. 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à CURRENCY. Phải để trống đối với các chỉ số có đơn vị đo lường không phải là CURRENCY.

MeasurementUnit

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

Cách biểu diễn đơn vị tiền tệ có thể thay đổi trong tương lai, đòi hỏi phải có một thay đổi mang tính đột phá về API.

Enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit 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 feet.
METERS Chỉ số này đo lường mét.
KILOMETERS Chỉ số này đo lường ki-lô-mét.
MILES Chỉ số này đo lường dặm.
MILLISECONDS Chỉ số này đo lường mili giây.
SECONDS Chỉ số này đo lường giây.
MINUTES Chỉ số này đo lường 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 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ố tùy chỉnh này là dữ liệu cần bị hạn chế đối với những người dùng cụ thể.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Loại không xác định hoặc không đượ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 CustomMetric.

get

 Tìm kiếm 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.