REST Resource: properties.customMetrics

منبع: CustomMetric

تعریفی برای یک متریک سفارشی.

نمایندگی JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
زمینه های
name

string

فقط خروجی نام منبع برای این منبع CustomMetric. قالب: خواص/{property}/customMetrics/{customMetric}

parameterName

string

ضروری. تغییرناپذیر. نام برچسب گذاری برای این معیار سفارشی.

اگر این یک متریک با دامنه رویداد است، این نام پارامتر رویداد است.

ممکن است فقط شامل نویسه‌های حروف عددی و زیرخط باشد که با یک حرف شروع می‌شوند. حداکثر طول 40 نویسه برای معیارهای محدوده رویداد.

displayName

string

ضروری. نام نمایشی برای این معیار سفارشی همانطور که در رابط کاربری Analytics نشان داده شده است. حداکثر طول 82 کاراکتر، حروف عددی به اضافه فاصله و خط زیر که با یک حرف شروع می شود. نام‌های نمایشی تولید شده توسط سیستم قدیمی ممکن است دارای کروشه باشد، اما به‌روزرسانی‌های این فیلد هرگز اجازه ایجاد براکت را نمی‌دهد.

description

string

اختیاری. توضیحات برای این بعد سفارشی. حداکثر طول 150 کاراکتر

measurementUnit

enum ( MeasurementUnit )

ضروری. نوع مقدار متریک سفارشی.

scope

enum ( MetricScope )

ضروری. تغییرناپذیر. دامنه این معیار سفارشی.

restrictedMetricType[]

enum ( RestrictedMetricType )

اختیاری. انواع داده‌های محدود شده که این معیار ممکن است شامل شود. برای معیارهای با واحد اندازه گیری CURRENCY مورد نیاز است. برای معیارهایی با واحد اندازه گیری غیر CURRENCY باید خالی باشد.

واحد اندازه گیری

انواع احتمالی نمایش مقدار معیار سفارشی.

نمایش ارز ممکن است در آینده تغییر کند، که نیاز به تغییر API قطعی دارد.

Enums
MEASUREMENT_UNIT_UNSPECIFIED واحد اندازه گیری مشخص نشده یا وجود ندارد.
STANDARD این معیار از واحدهای پیش فرض استفاده می کند.
CURRENCY این معیار یک واحد پولی را اندازه گیری می کند.
FEET این متریک پاها را اندازه گیری می کند.
METERS این متریک متر را اندازه گیری می کند.
KILOMETERS این متریک کیلومتر را اندازه گیری می کند.
MILES این متریک مایل ها را اندازه گیری می کند.
MILLISECONDS این متریک میلی ثانیه را اندازه گیری می کند.
SECONDS این متریک ثانیه ها را اندازه گیری می کند.
MINUTES این متریک دقیقه ها را اندازه گیری می کند.
HOURS این متریک ساعت ها را اندازه گیری می کند.

MetricScope

دامنه این متریک.

Enums
METRIC_SCOPE_UNSPECIFIED محدوده نامعلوم یا مشخص نشده است.
EVENT مقیاس اندازه گیری به یک رویداد.

RestrictedMetricType

برچسب‌هایی که داده‌ها را در این معیار سفارشی به‌عنوان داده‌هایی که باید به کاربران خاصی محدود شود، علامت‌گذاری می‌کنند.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED تایپ ناشناخته یا نامشخص
COST_DATA داده های هزینه گزارش های متریک
REVENUE_DATA Metric داده های درآمد را گزارش می دهد.

مواد و روش ها

archive

 CustomMetric را در یک ملک بایگانی می کند.

create

 CustomMetric ایجاد می کند.

get

 جستجو برای یک CustomMetric واحد.

list

 CustomMetrics را در یک ویژگی فهرست می کند.

patch

 CustomMetric را در یک ویژگی به روز می کند.