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. قالب: properties/{property}/customMetrics/{customMetric}

parameterName

string

الزامی. تغییرناپذیر. نام برچسب‌گذاری برای این معیار سفارشی.

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

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

displayName

string

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

description

string

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

measurementUnit

enum ( MeasurementUnit )

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

scope

enum ( MetricScope )

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

restrictedMetricType[]

enum ( RestrictedMetricType )

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

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

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

ممکن است در آینده نحوه‌ی نمایش ارز تغییر کند و نیاز به تغییر اساسی در API باشد.

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

متریک‌اسکوپ

دامنه این معیار.

انوم‌ها
METRIC_SCOPE_UNSPECIFIED محدوده نامشخص یا مشخص نشده است.
EVENT معیار به یک رویداد محدود می‌شود.

نوع متریک محدود

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

انوم‌ها
RESTRICTED_METRIC_TYPE_UNSPECIFIED نوع نامشخص یا نامشخص.
COST_DATA گزارش‌های متریک، داده‌های هزینه را نشان می‌دهند.
REVENUE_DATA متریک داده‌های درآمد را گزارش می‌دهد.

روش‌ها

archive

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

create

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

get

 به دنبال یک CustomMetric واحد بگردید.

list

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

patch

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