REST Resource: properties.calculatedMetrics

منبع: CalculatedMetric

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

نمایش JSON 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
فیلدها
name

string

شناسه. نام منبع برای این CalculatedMetric. قالب: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

اختیاری. توضیحات برای این معیار محاسبه شده. حداکثر طول ۴۰۹۶ کاراکتر.

displayName

string

الزامی. نام نمایشی برای این معیار محاسبه‌شده، همانطور که در رابط کاربری گوگل آنالیتیکس نشان داده شده است. حداکثر طول ۸۲ کاراکتر.

calculatedMetricId

string

فقط خروجی. شناسه‌ای که برای معیار محاسبه‌شده استفاده می‌شود. در رابط کاربری، به آن «نام API» گفته می‌شود.

هنگام ارجاع به این معیار محاسبه‌شده از APIهای خارجی، از calculateMetricId استفاده می‌شود. برای مثال، "calcMetric:{calculatedMetricId}".

metricUnit

enum ( MetricUnit )

الزامی. نوع مقدار معیار محاسبه‌شده.

restrictedMetricType[]

enum ( RestrictedMetricType )

فقط خروجی. انواع داده‌های محدود شده‌ای که این معیار شامل می‌شود.

formula

string

الزامی. تعریف معیار محاسبه شده. حداکثر تعداد معیارهای سفارشی منحصر به فرد ارجاع شده ۵ است. فرمول‌ها از عملیات زیر پشتیبانی می‌کنند: + (جمع)، - (تفریق)، - (منفی)، * (ضرب)، / (تقسیم)، () (پرانتز). هر عدد حقیقی معتبری که در یک Long (عدد صحیح ۶۴ بیتی) یا یک Double (عدد ممیز شناور ۶۴ بیتی) جای بگیرد، قابل قبول است. فرمول مثال: "(customEvent:parameterName + cartPurchaseQuantity) / 2.0"

invalidMetricReference

boolean

فقط خروجی. اگر درست باشد، این معیار محاسبه‌شده دارای یک مرجع معیار نامعتبر است. هر چیزی که از یک معیار محاسبه‌شده با invalidMetricReference تنظیم‌شده روی درست استفاده کند، ممکن است با شکست مواجه شود، هشدار تولید کند یا نتایج غیرمنتظره‌ای تولید کند.

واحد متریک

انواع ممکن برای نمایش مقدار معیار محاسبه‌شده.

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

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

برچسب‌هایی که داده‌ها را در معیار محاسبه‌شده علامت‌گذاری می‌کنند، همراه با نقش‌های کاربری که دسترسی به معیارهای هزینه و/یا درآمد را محدود می‌کنند، استفاده می‌شوند.

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

روش‌ها

create

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

delete

 یک CalculatedMetric را روی یک ویژگی حذف می‌کند.

get

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

list

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

patch

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